chore: integration example for tm websocket

integrations/tm/.env.example

@@ -0,0 +1 @@
+LOG_LEVEL=info

integrations/tm/.npmignore

@@ -0,0 +1,8 @@
+# Blacklist all files
+.*
+*
+src
+
+# Whitelist dist
+!dist/**/*.d.ts
+!dist/**/*.js

integrations/tm/LICENSE

@@ -0,0 +1,203 @@
+Copyright © 2021 - 2022 Injective Labs Inc. (https://injectivelabs.org/)
+
+                                 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 [2022] [InjectiveLabs]
+
+   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.

integrations/tm/README.md

@@ -0,0 +1,36 @@
+# 🌟 Injective Protocol - Integration TM
+
+
+---
+
+## 📚 Installation
+
+---
+
+## ⛑ Support
+
+Reach out to us at one of the following places!
+
+- Website at <a href="https://injective.com" target="_blank">`injective.com`</a>
+- Twitter at <a href="https://twitter.com/Injective_" target="_blank">`@Injective`</a>
+- Discord at <a href="https://discord.com/invite/NK4qdbv" target="_blank">`Discord`</a>
+- Telegram at <a href="https://t.me/joininjective" target="_blank">`Telegram`</a>
+
+---
+
+## 🔓 License
+
+Copyright © 2021 - 2022 Injective Labs Inc. (https://injectivelabs.org/)
+
+<a href="https://iili.io/mNneZN.md.png"><img src="https://iili.io/mNneZN.md.png" style="width: 300px; max-width: 100%; height: auto" />
+
+Originally released by Injective Labs Inc. under: <br />
+Apache License <br />
+Version 2.0, January 2004 <br />
+http://www.apache.org/licenses/
+
+
+<p>&nbsp;</p>
+<div align="center">
+  <sub><em>Powering the future of decentralized finance.</em></sub>
+</div>

integrations/tm/jest.config.js

@@ -0,0 +1,10 @@
+import baseConfig from '../../jest.config.js'
+
+export default {
+  ...baseConfig,
+  globals: {
+    'ts-jest': {
+      tsConfig: 'tsconfig.build.esm.json',
+    },
+  },
+}

integrations/tm/package.json

@@ -0,0 +1,58 @@
+{
+  "name": "integration-tm",
+  "private": true,
+  "description": "",
+  "version": "0.0.1",
+  "sideEffects": false,
+  "license": "Apache-2.0",
+  "type": "module",
+  "types": "dist/cjs/index.d.ts",
+  "main": "dist/cjs/index.js",
+  "module": "dist/esm/index.js",
+  "author": {
+    "name": "InjectiveLabs",
+    "email": "[email protected]"
+  },
+  "files": [
+    "dist"
+  ],
+  "exports": {
+    ".": {
+      "react-native": {
+        "import": "./dist/esm/index.js",
+        "require": "./dist/cjs/index.js",
+        "types": "./dist/cjs/index.d.ts",
+        "default": "./dist/cjs/index.js"
+      },
+      "require": {
+        "types": "./dist/cjs/index.d.ts",
+        "default": "./dist/cjs/index.js"
+      },
+      "import": {
+        "types": "./dist/esm/index.d.ts",
+        "default": "./dist/esm/index.js"
+      },
+      "default": {
+        "types": "./dist/cjs/index.d.ts",
+        "default": "./dist/cjs/index.js"
+      }
+    }
+  },
+  "scripts": {
+    "start:example": "node --loader ts-node/esm ./src/example.ts"
+  },
+  "devDependencies": {
+    "@types/node-persist": "^3.1.8",
+    "shx": "^0.3.4"
+  },
+  "gitHead": "6442ae377bbfb3459d2fb3a44c650630a5b7f445",
+  "dependencies": {
+    "@injectivelabs/networks": "^1.15.3",
+    "@ledgerhq/hw-transport": "^6.28.4",
+    "dotenv": "^16.5.0",
+    "node-persist": "^4.0.4",
+    "ts-node": "^10.9.2",
+    "winston": "^3.17.0",
+    "ws": "^8.18.2"
+  }
+}

integrations/tm/src/client/handlers/blocks.ts

@@ -0,0 +1,10 @@
+import { NewBlockEvent } from '../../types.js'
+import { logger } from '../../logger.js'
+
+export async function handleNewBlock(data: NewBlockEvent['value']) {
+  const height = parseInt(data.block.header.height)
+
+  logger.info(`🧱 Indexed block #${height}`)
+
+  // Add indexing logic...
+}

integrations/tm/src/client/handlers/txs.ts

@@ -0,0 +1,10 @@
+import { NewTxEvent } from '../../types.js'
+import { logger } from '../../logger.js'
+
+export async function handleNewTx(data: NewTxEvent['value']) {
+  const height = parseInt(data.TxResult.height)
+
+  logger.info(`📨 Indexed Tx at height ${height}`)
+
+  // Add indexing logic...
+}

integrations/tm/src/client/indexer.ts

@@ -0,0 +1,53 @@
+import { WebSocketClient } from './ws.js'
+import { handleNewBlock } from './handlers/blocks.js'
+import { handleNewTx } from './handlers/txs.js'
+import { NewBlockEvent, NewTxEvent, type MessageHandlerArgs } from '../types.js'
+import { logger } from '../logger.js'
+
+export class CometBFTIndexer {
+  private ws: WebSocketClient
+
+  constructor(endpoints: string[]) {
+    this.ws = new WebSocketClient(endpoints, this.onMessage.bind(this))
+  }
+
+  public subscribe() {
+    const subs = [{ query: "tm.event='NewBlock'" }, { query: "tm.event='Tx'" }]
+
+    for (const sub of subs) {
+      this.ws.send({
+        jsonrpc: '2.0',
+        method: 'subscribe',
+        id: Math.floor(Math.random() * 1_000_000),
+        params: sub,
+      })
+    }
+  }
+
+  private async onMessage(msg: MessageHandlerArgs) {
+    const data = msg?.result?.data
+
+    if (!data) {
+      logger.debug('📦 Message data doesnt exist or is undefined:', msg)
+
+      return
+    }
+
+    if (!data.type) {
+      logger.debug('📦 Message type doesnt exist or is undefined:', msg)
+
+      return
+    }
+
+    switch (data.type) {
+      case 'tendermint/event/NewBlock':
+        await handleNewBlock(data.value as NewBlockEvent['value'])
+        break
+      case 'tendermint/event/Tx':
+        await handleNewTx(data.value as NewTxEvent['value'])
+        break
+      default:
+        logger.warn('📦 Unhandled message type:', data.type)
+    }
+  }
+}