Add watcher base files and structures (#237)
* Add watcher base files and structures * Add missed files! * Update package.json info * Update PythUpdateEvent * Restructure the code * Fix division
This commit is contained in:
parent
9dbfbd4174
commit
1f785d5a7f
|
@ -0,0 +1,3 @@
|
|||
node_modules
|
||||
lib
|
||||
.dccache
|
|
@ -0,0 +1,201 @@
|
|||
Apache License
|
||||
Version 2.0, January 2004
|
||||
http://www.apache.org/licenses/
|
||||
|
||||
TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
|
||||
|
||||
1. Definitions.
|
||||
|
||||
"License" shall mean the terms and conditions for use, reproduction,
|
||||
and distribution as defined by Sections 1 through 9 of this document.
|
||||
|
||||
"Licensor" shall mean the copyright owner or entity authorized by
|
||||
the copyright owner that is granting the License.
|
||||
|
||||
"Legal Entity" shall mean the union of the acting entity and all
|
||||
other entities that control, are controlled by, or are under common
|
||||
control with that entity. For the purposes of this definition,
|
||||
"control" means (i) the power, direct or indirect, to cause the
|
||||
direction or management of such entity, whether by contract or
|
||||
otherwise, or (ii) ownership of fifty percent (50%) or more of the
|
||||
outstanding shares, or (iii) beneficial ownership of such entity.
|
||||
|
||||
"You" (or "Your") shall mean an individual or Legal Entity
|
||||
exercising permissions granted by this License.
|
||||
|
||||
"Source" form shall mean the preferred form for making modifications,
|
||||
including but not limited to software source code, documentation
|
||||
source, and configuration files.
|
||||
|
||||
"Object" form shall mean any form resulting from mechanical
|
||||
transformation or translation of a Source form, including but
|
||||
not limited to compiled object code, generated documentation,
|
||||
and conversions to other media types.
|
||||
|
||||
"Work" shall mean the work of authorship, whether in Source or
|
||||
Object form, made available under the License, as indicated by a
|
||||
copyright notice that is included in or attached to the work
|
||||
(an example is provided in the Appendix below).
|
||||
|
||||
"Derivative Works" shall mean any work, whether in Source or Object
|
||||
form, that is based on (or derived from) the Work and for which the
|
||||
editorial revisions, annotations, elaborations, or other modifications
|
||||
represent, as a whole, an original work of authorship. For the purposes
|
||||
of this License, Derivative Works shall not include works that remain
|
||||
separable from, or merely link (or bind by name) to the interfaces of,
|
||||
the Work and Derivative Works thereof.
|
||||
|
||||
"Contribution" shall mean any work of authorship, including
|
||||
the original version of the Work and any modifications or additions
|
||||
to that Work or Derivative Works thereof, that is intentionally
|
||||
submitted to Licensor for inclusion in the Work by the copyright owner
|
||||
or by an individual or Legal Entity authorized to submit on behalf of
|
||||
the copyright owner. For the purposes of this definition, "submitted"
|
||||
means any form of electronic, verbal, or written communication sent
|
||||
to the Licensor or its representatives, including but not limited to
|
||||
communication on electronic mailing lists, source code control systems,
|
||||
and issue tracking systems that are managed by, or on behalf of, the
|
||||
Licensor for the purpose of discussing and improving the Work, but
|
||||
excluding communication that is conspicuously marked or otherwise
|
||||
designated in writing by the copyright owner as "Not a Contribution."
|
||||
|
||||
"Contributor" shall mean Licensor and any individual or Legal Entity
|
||||
on behalf of whom a Contribution has been received by Licensor and
|
||||
subsequently incorporated within the Work.
|
||||
|
||||
2. Grant of Copyright License. Subject to the terms and conditions of
|
||||
this License, each Contributor hereby grants to You a perpetual,
|
||||
worldwide, non-exclusive, no-charge, royalty-free, irrevocable
|
||||
copyright license to reproduce, prepare Derivative Works of,
|
||||
publicly display, publicly perform, sublicense, and distribute the
|
||||
Work and such Derivative Works in Source or Object form.
|
||||
|
||||
3. Grant of Patent License. Subject to the terms and conditions of
|
||||
this License, each Contributor hereby grants to You a perpetual,
|
||||
worldwide, non-exclusive, no-charge, royalty-free, irrevocable
|
||||
(except as stated in this section) patent license to make, have made,
|
||||
use, offer to sell, sell, import, and otherwise transfer the Work,
|
||||
where such license applies only to those patent claims licensable
|
||||
by such Contributor that are necessarily infringed by their
|
||||
Contribution(s) alone or by combination of their Contribution(s)
|
||||
with the Work to which such Contribution(s) was submitted. If You
|
||||
institute patent litigation against any entity (including a
|
||||
cross-claim or counterclaim in a lawsuit) alleging that the Work
|
||||
or a Contribution incorporated within the Work constitutes direct
|
||||
or contributory patent infringement, then any patent licenses
|
||||
granted to You under this License for that Work shall terminate
|
||||
as of the date such litigation is filed.
|
||||
|
||||
4. Redistribution. You may reproduce and distribute copies of the
|
||||
Work or Derivative Works thereof in any medium, with or without
|
||||
modifications, and in Source or Object form, provided that You
|
||||
meet the following conditions:
|
||||
|
||||
(a) You must give any other recipients of the Work or
|
||||
Derivative Works a copy of this License; and
|
||||
|
||||
(b) You must cause any modified files to carry prominent notices
|
||||
stating that You changed the files; and
|
||||
|
||||
(c) You must retain, in the Source form of any Derivative Works
|
||||
that You distribute, all copyright, patent, trademark, and
|
||||
attribution notices from the Source form of the Work,
|
||||
excluding those notices that do not pertain to any part of
|
||||
the Derivative Works; and
|
||||
|
||||
(d) If the Work includes a "NOTICE" text file as part of its
|
||||
distribution, then any Derivative Works that You distribute must
|
||||
include a readable copy of the attribution notices contained
|
||||
within such NOTICE file, excluding those notices that do not
|
||||
pertain to any part of the Derivative Works, in at least one
|
||||
of the following places: within a NOTICE text file distributed
|
||||
as part of the Derivative Works; within the Source form or
|
||||
documentation, if provided along with the Derivative Works; or,
|
||||
within a display generated by the Derivative Works, if and
|
||||
wherever such third-party notices normally appear. The contents
|
||||
of the NOTICE file are for informational purposes only and
|
||||
do not modify the License. You may add Your own attribution
|
||||
notices within Derivative Works that You distribute, alongside
|
||||
or as an addendum to the NOTICE text from the Work, provided
|
||||
that such additional attribution notices cannot be construed
|
||||
as modifying the License.
|
||||
|
||||
You may add Your own copyright statement to Your modifications and
|
||||
may provide additional or different license terms and conditions
|
||||
for use, reproduction, or distribution of Your modifications, or
|
||||
for any such Derivative Works as a whole, provided Your use,
|
||||
reproduction, and distribution of the Work otherwise complies with
|
||||
the conditions stated in this License.
|
||||
|
||||
5. Submission of Contributions. Unless You explicitly state otherwise,
|
||||
any Contribution intentionally submitted for inclusion in the Work
|
||||
by You to the Licensor shall be under the terms and conditions of
|
||||
this License, without any additional terms or conditions.
|
||||
Notwithstanding the above, nothing herein shall supersede or modify
|
||||
the terms of any separate license agreement you may have executed
|
||||
with Licensor regarding such Contributions.
|
||||
|
||||
6. Trademarks. This License does not grant permission to use the trade
|
||||
names, trademarks, service marks, or product names of the Licensor,
|
||||
except as required for reasonable and customary use in describing the
|
||||
origin of the Work and reproducing the content of the NOTICE file.
|
||||
|
||||
7. Disclaimer of Warranty. Unless required by applicable law or
|
||||
agreed to in writing, Licensor provides the Work (and each
|
||||
Contributor provides its Contributions) on an "AS IS" BASIS,
|
||||
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
|
||||
implied, including, without limitation, any warranties or conditions
|
||||
of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
|
||||
PARTICULAR PURPOSE. You are solely responsible for determining the
|
||||
appropriateness of using or redistributing the Work and assume any
|
||||
risks associated with Your exercise of permissions under this License.
|
||||
|
||||
8. Limitation of Liability. In no event and under no legal theory,
|
||||
whether in tort (including negligence), contract, or otherwise,
|
||||
unless required by applicable law (such as deliberate and grossly
|
||||
negligent acts) or agreed to in writing, shall any Contributor be
|
||||
liable to You for damages, including any direct, indirect, special,
|
||||
incidental, or consequential damages of any character arising as a
|
||||
result of this License or out of the use or inability to use the
|
||||
Work (including but not limited to damages for loss of goodwill,
|
||||
work stoppage, computer failure or malfunction, or any and all
|
||||
other commercial damages or losses), even if such Contributor
|
||||
has been advised of the possibility of such damages.
|
||||
|
||||
9. Accepting Warranty or Additional Liability. While redistributing
|
||||
the Work or Derivative Works thereof, You may choose to offer,
|
||||
and charge a fee for, acceptance of support, warranty, indemnity,
|
||||
or other liability obligations and/or rights consistent with this
|
||||
License. However, in accepting such obligations, You may act only
|
||||
on Your own behalf and on Your sole responsibility, not on behalf
|
||||
of any other Contributor, and only if You agree to indemnify,
|
||||
defend, and hold each Contributor harmless for any liability
|
||||
incurred by, or claims asserted against, such Contributor by reason
|
||||
of your accepting any such warranty or additional liability.
|
||||
|
||||
END OF TERMS AND CONDITIONS
|
||||
|
||||
APPENDIX: How to apply the Apache License to your work.
|
||||
|
||||
To apply the Apache License to your work, attach the following
|
||||
boilerplate notice, with the fields enclosed by brackets "[]"
|
||||
replaced with your own identifying information. (Don't include
|
||||
the brackets!) The text should be enclosed in the appropriate
|
||||
comment syntax for the file format. We also recommend that a
|
||||
file or class name and description of purpose be included on the
|
||||
same "printed page" as the copyright notice for easier
|
||||
identification within third-party archives.
|
||||
|
||||
Copyright [2021] [Pyth Data Foundation]
|
||||
|
||||
Licensed under the Apache License, Version 2.0 (the "License");
|
||||
you may not use this file except in compliance with the License.
|
||||
You may obtain a copy of the License at
|
||||
|
||||
http://www.apache.org/licenses/LICENSE-2.0
|
||||
|
||||
Unless required by applicable law or agreed to in writing, software
|
||||
distributed under the License is distributed on an "AS IS" BASIS,
|
||||
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
|
||||
See the License for the specific language governing permissions and
|
||||
limitations under the License.
|
|
@ -0,0 +1,5 @@
|
|||
/** @type {import('ts-jest/dist/types').InitialOptionsTsJest} */
|
||||
module.exports = {
|
||||
preset: 'ts-jest',
|
||||
testEnvironment: 'node',
|
||||
};
|
File diff suppressed because it is too large
Load Diff
|
@ -0,0 +1,47 @@
|
|||
{
|
||||
"name": "@pythnetwork/pyth-evm-watcher",
|
||||
"version": "0.1.0",
|
||||
"description": "Pyth EVM Watcher",
|
||||
"homepage": "https://pyth.network",
|
||||
"main": "lib/index.js",
|
||||
"types": "lib/index.d.ts",
|
||||
"files": [
|
||||
"lib/**/*"
|
||||
],
|
||||
"repository": "https://github.com/pyth-network/pyth-crosschain",
|
||||
"scripts": {
|
||||
"test": "jest src/ --passWithNoTests",
|
||||
"build": "tsc",
|
||||
"start": "node lib/index.js",
|
||||
"format": "prettier --write \"src/**/*.ts\"",
|
||||
"lint": "eslint src/",
|
||||
"prepare": "npm run build",
|
||||
"prepublishOnly": "npm test && npm run lint",
|
||||
"preversion": "npm run lint",
|
||||
"version": "npm run format && git add -A src"
|
||||
},
|
||||
"keywords": [
|
||||
"pyth",
|
||||
"oracle",
|
||||
"evm",
|
||||
"ethereum"
|
||||
],
|
||||
"license": "Apache-2.0",
|
||||
"devDependencies": {
|
||||
"@types/jest": "^27.5.2",
|
||||
"@typescript-eslint/eslint-plugin": "^5.29.0",
|
||||
"@typescript-eslint/parser": "^5.29.0",
|
||||
"eslint": "^8.18.0",
|
||||
"jest": "^27.5.1",
|
||||
"prettier": "^2.7.1",
|
||||
"ts-jest": "^27.1.5",
|
||||
"typescript": "^4.7.4"
|
||||
},
|
||||
"dependencies": {
|
||||
"dotenv": "^16.0.1",
|
||||
"web3": "^1.7.4",
|
||||
"web3-eth-contract": "^1.7.4",
|
||||
"web3-providers-ws": "^1.7.4",
|
||||
"web3-utils": "^1.7.4"
|
||||
}
|
||||
}
|
|
@ -0,0 +1,147 @@
|
|||
[
|
||||
{
|
||||
"anonymous": false,
|
||||
"inputs": [
|
||||
{
|
||||
"indexed": true,
|
||||
"internalType": "bytes32",
|
||||
"name": "id",
|
||||
"type": "bytes32"
|
||||
},
|
||||
{
|
||||
"indexed": false,
|
||||
"internalType": "uint64",
|
||||
"name": "publishTime",
|
||||
"type": "uint64"
|
||||
}
|
||||
],
|
||||
"name": "PriceUpdate",
|
||||
"type": "event"
|
||||
},
|
||||
{
|
||||
"inputs": [
|
||||
{
|
||||
"internalType": "bytes32",
|
||||
"name": "id",
|
||||
"type": "bytes32"
|
||||
}
|
||||
],
|
||||
"name": "getCurrentPrice",
|
||||
"outputs": [
|
||||
{
|
||||
"components": [
|
||||
{
|
||||
"internalType": "int64",
|
||||
"name": "price",
|
||||
"type": "int64"
|
||||
},
|
||||
{
|
||||
"internalType": "uint64",
|
||||
"name": "conf",
|
||||
"type": "uint64"
|
||||
},
|
||||
{
|
||||
"internalType": "int32",
|
||||
"name": "expo",
|
||||
"type": "int32"
|
||||
}
|
||||
],
|
||||
"internalType": "struct PythStructs.Price",
|
||||
"name": "price",
|
||||
"type": "tuple"
|
||||
}
|
||||
],
|
||||
"stateMutability": "view",
|
||||
"type": "function"
|
||||
},
|
||||
{
|
||||
"inputs": [
|
||||
{
|
||||
"internalType": "bytes32",
|
||||
"name": "id",
|
||||
"type": "bytes32"
|
||||
}
|
||||
],
|
||||
"name": "getEmaPrice",
|
||||
"outputs": [
|
||||
{
|
||||
"components": [
|
||||
{
|
||||
"internalType": "int64",
|
||||
"name": "price",
|
||||
"type": "int64"
|
||||
},
|
||||
{
|
||||
"internalType": "uint64",
|
||||
"name": "conf",
|
||||
"type": "uint64"
|
||||
},
|
||||
{
|
||||
"internalType": "int32",
|
||||
"name": "expo",
|
||||
"type": "int32"
|
||||
}
|
||||
],
|
||||
"internalType": "struct PythStructs.Price",
|
||||
"name": "price",
|
||||
"type": "tuple"
|
||||
}
|
||||
],
|
||||
"stateMutability": "view",
|
||||
"type": "function"
|
||||
},
|
||||
{
|
||||
"inputs": [
|
||||
{
|
||||
"internalType": "bytes32",
|
||||
"name": "id",
|
||||
"type": "bytes32"
|
||||
}
|
||||
],
|
||||
"name": "getPrevPriceUnsafe",
|
||||
"outputs": [
|
||||
{
|
||||
"components": [
|
||||
{
|
||||
"internalType": "int64",
|
||||
"name": "price",
|
||||
"type": "int64"
|
||||
},
|
||||
{
|
||||
"internalType": "uint64",
|
||||
"name": "conf",
|
||||
"type": "uint64"
|
||||
},
|
||||
{
|
||||
"internalType": "int32",
|
||||
"name": "expo",
|
||||
"type": "int32"
|
||||
}
|
||||
],
|
||||
"internalType": "struct PythStructs.Price",
|
||||
"name": "price",
|
||||
"type": "tuple"
|
||||
},
|
||||
{
|
||||
"internalType": "uint64",
|
||||
"name": "publishTime",
|
||||
"type": "uint64"
|
||||
}
|
||||
],
|
||||
"stateMutability": "view",
|
||||
"type": "function"
|
||||
},
|
||||
{
|
||||
"inputs": [
|
||||
{
|
||||
"internalType": "bytes[]",
|
||||
"name": "updateData",
|
||||
"type": "bytes[]"
|
||||
}
|
||||
],
|
||||
"name": "updatePriceFeeds",
|
||||
"outputs": [],
|
||||
"stateMutability": "nonpayable",
|
||||
"type": "function"
|
||||
}
|
||||
]
|
|
@ -0,0 +1,20 @@
|
|||
import { PythUpdateEvent } from "./pyth-update-event";
|
||||
import { Watcher } from "./watcher";
|
||||
|
||||
export class Handler {
|
||||
private watchers: Watcher[];
|
||||
|
||||
constructor() {
|
||||
this.watchers = [];
|
||||
}
|
||||
|
||||
dispatchEvent(event: PythUpdateEvent) {
|
||||
for (let watcher of this.watchers) {
|
||||
watcher.processEvent(event);
|
||||
}
|
||||
}
|
||||
|
||||
subscribe(watcher: Watcher) {
|
||||
this.watchers.push(watcher);
|
||||
}
|
||||
}
|
|
@ -0,0 +1,19 @@
|
|||
import { Handler } from "./handler";
|
||||
import { Listener } from "./listener";
|
||||
import { envOrErr } from "./utils";
|
||||
import { Logger } from "./watchers/logger";
|
||||
|
||||
console.log("Loading config file .env");
|
||||
require("dotenv").config();
|
||||
|
||||
const handler = new Handler();
|
||||
const listener = new Listener({
|
||||
wsEndpoint: envOrErr('WS_ENDPOINT'),
|
||||
pythContract: envOrErr('PYTH_CONTRACT'),
|
||||
}, handler);
|
||||
|
||||
// Initialize Watchers
|
||||
const logger = new Logger();
|
||||
handler.subscribe(logger);
|
||||
|
||||
listener.start();
|
|
@ -0,0 +1,66 @@
|
|||
import Web3 from "web3";
|
||||
import { Contract, EventData } from "web3-eth-contract";
|
||||
import { WebsocketProvider as WebsocketProviderType } from "web3-providers-ws";
|
||||
import WebsocketProvider from "web3-providers-ws";
|
||||
import { AbiItem } from "web3-utils";
|
||||
import IPythABI from "./abi.json"
|
||||
import { Handler } from "./handler";
|
||||
|
||||
type ListenerConfig = {
|
||||
wsEndpoint: string,
|
||||
pythContract: string
|
||||
};
|
||||
|
||||
export class Listener {
|
||||
private web3: Web3;
|
||||
private pythContract: Contract;
|
||||
private handler: Handler;
|
||||
|
||||
constructor(config: ListenerConfig, handler: Handler) {
|
||||
// @ts-ignore The type definition is not correct and complains here. So it is ignored.
|
||||
const wsProvider = new WebsocketProvider(config.wsEndpoint, {
|
||||
clientConfig: {
|
||||
keepalive: true,
|
||||
keepaliveInterval: 30000
|
||||
},
|
||||
reconnect: {
|
||||
auto: true,
|
||||
delay: 1000,
|
||||
onTimeout: true,
|
||||
}
|
||||
});
|
||||
this.web3 = new Web3(wsProvider);
|
||||
this.pythContract = new this.web3.eth.Contract(IPythABI as AbiItem[], config.pythContract);
|
||||
this.handler = handler;
|
||||
}
|
||||
|
||||
async getTxFee(txhash: string): Promise<number> {
|
||||
const txReceipt = await this.web3.eth.getTransactionReceipt(txhash);
|
||||
|
||||
var gasPrice: number;
|
||||
|
||||
// In some networks such as BNB effective gas price is not provided in response.
|
||||
if (txReceipt.effectiveGasPrice !== undefined) {
|
||||
gasPrice = txReceipt.effectiveGasPrice;
|
||||
} else {
|
||||
const tx = await this.web3.eth.getTransaction(txhash);
|
||||
gasPrice = Number(tx.gasPrice);
|
||||
}
|
||||
|
||||
return gasPrice * txReceipt.gasUsed / Math.pow(10, 18);
|
||||
}
|
||||
|
||||
start() {
|
||||
this.web3.eth.subscribe('newBlockHeaders', (_error: Error, blockHeader) => {
|
||||
console.dir(blockHeader);
|
||||
});
|
||||
const pythEmitter = this.pythContract.events.PriceUpdate(undefined, async (_error: Error, event: EventData) => {
|
||||
console.dir(event);
|
||||
});
|
||||
}
|
||||
|
||||
stop() {
|
||||
const wsProvider = this.web3.currentProvider as WebsocketProviderType;
|
||||
wsProvider.disconnect();
|
||||
}
|
||||
}
|
|
@ -0,0 +1,25 @@
|
|||
import { HexString, UnixTimestamp } from "./utils"
|
||||
|
||||
export type PythUpdateEvent = {
|
||||
txHash: HexString,
|
||||
txFrom: HexString,
|
||||
txTo: HexString,
|
||||
chainId: number,
|
||||
sequenceNumber: number,
|
||||
sender: HexString, // Equal to txTo when a contract calls updatePriceFeeds and txFrom when someone calls Pyth contract directly
|
||||
block: number,
|
||||
timestamp: UnixTimestamp,
|
||||
rawInput: string,
|
||||
gasUsage: number,
|
||||
txFee: number,
|
||||
batchSize: number,
|
||||
numUpdatedPrices: number,
|
||||
prices: {
|
||||
id: HexString,
|
||||
updated: boolean,
|
||||
publishTime: UnixTimestamp,
|
||||
existingPublishTime: UnixTimestamp,
|
||||
price: string,
|
||||
conf: string,
|
||||
}[]
|
||||
}
|
|
@ -0,0 +1,15 @@
|
|||
export type HexString = string;
|
||||
export type UnixTimestamp = number;
|
||||
|
||||
export function sleep(ms: number) {
|
||||
return new Promise((resolve) => setTimeout(resolve, ms));
|
||||
}
|
||||
|
||||
// Shorthand for optional/mandatory envs
|
||||
export function envOrErr(env: string): string {
|
||||
let val = process.env[env];
|
||||
if (!val) {
|
||||
throw `environment variable "${env}" must be set`;
|
||||
}
|
||||
return String(process.env[env]);
|
||||
}
|
|
@ -0,0 +1,5 @@
|
|||
import { PythUpdateEvent } from "./pyth-update-event";
|
||||
|
||||
export interface Watcher {
|
||||
processEvent(event: PythUpdateEvent): void;
|
||||
}
|
|
@ -0,0 +1,8 @@
|
|||
import { PythUpdateEvent } from "../pyth-update-event";
|
||||
import { Watcher } from "../watcher";
|
||||
|
||||
export class Logger implements Watcher {
|
||||
processEvent(event: PythUpdateEvent) {
|
||||
console.dir(event);
|
||||
}
|
||||
}
|
|
@ -0,0 +1,13 @@
|
|||
{
|
||||
"compilerOptions": {
|
||||
"target": "esnext",
|
||||
"module": "commonjs",
|
||||
"declaration": true,
|
||||
"outDir": "./lib",
|
||||
"strict": true,
|
||||
"esModuleInterop": true,
|
||||
"resolveJsonModule": true
|
||||
},
|
||||
"include": ["src"],
|
||||
"exclude": ["node_modules"]
|
||||
}
|
Loading…
Reference in New Issue