Merge pull request #7238 from ethereum-optimism/09-13-feat_indexer_Publish_types_for_api

feat(indexer): Publish typescript types for api

indexer/api-ts/LICENSE

+MIT License
+
+Copyright (c) 2022 Optimism
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

indexer/api-ts/generated.ts

+// Code generated by tygo. DO NOT EDIT.
+
+//////////
+// source: deposits.go
+
+export interface DepositItem {
+  guid: string;
+  from: string;
+  to: string;
+  timestamp: number /* uint64 */;
+  L1TxHash: string;
+  L2TxHash: string;
+  Block: string;
+  amount: string;
+  l1Token: string;
+  l2Token: string;
+}
+export interface DepositResponse {
+  cursor: string;
+  hasNextPage: boolean;
+  items: DepositItem[];
+}
+
+//////////
+// source: routes.go
+
+export interface Routes {
+  Logger: any /* log.Logger */;
+  BridgeTransfersView: any /* database.BridgeTransfersView */;
+  Router?: any /* chi.Mux */;
+}
+
+//////////
+// source: withdrawals.go
+
+export interface WithdrawalItem {
+  guid: string;
+  from: string;
+  to: string;
+  transactionHash: string;
+  timestamp: number /* uint64 */;
+  l2BlockHash: string;
+  amount: string;
+  proof: string;
+  claim: string;
+  l1Token: string;
+  l2Token: string;
+}
+export interface WithdrawalResponse {
+  cursor: string;
+  hasNextPage: boolean;
+  items: WithdrawalItem[];
+}

indexer/api-ts/indexer.cjs

+"use strict";
+var __defProp = Object.defineProperty;
+var __getOwnPropDesc = Object.getOwnPropertyDescriptor;
+var __getOwnPropNames = Object.getOwnPropertyNames;
+var __hasOwnProp = Object.prototype.hasOwnProperty;
+var __export = (target, all) => {
+  for (var name in all)
+    __defProp(target, name, { get: all[name], enumerable: true });
+};
+var __copyProps = (to, from, except, desc) => {
+  if (from && typeof from === "object" || typeof from === "function") {
+    for (let key of __getOwnPropNames(from))
+      if (!__hasOwnProp.call(to, key) && key !== except)
+        __defProp(to, key, { get: () => from[key], enumerable: !(desc = __getOwnPropDesc(from, key)) || desc.enumerable });
+  }
+  return to;
+};
+var __toCommonJS = (mod) => __copyProps(__defProp({}, "__esModule", { value: true }), mod);
+
+// indexer.ts
+var indexer_exports = {};
+__export(indexer_exports, {
+  depositEndpoint: () => depositEndpoint,
+  withdrawalEndoint: () => withdrawalEndoint
+});
+module.exports = __toCommonJS(indexer_exports);
+var createQueryString = ({ cursor, limit }) => {
+  if (cursor === void 0 && limit === void 0) {
+    return "";
+  }
+  const queries = [];
+  if (cursor) {
+    queries.push(`cursor=${cursor}`);
+  }
+  if (limit) {
+    queries.push(`limit=${limit}`);
+  }
+  return `?${queries.join("&")}`;
+};
+var depositEndpoint = ({ baseUrl = "", address, cursor, limit }) => {
+  return [baseUrl, "deposits", address, createQueryString({ cursor, limit })].join("/");
+};
+var withdrawalEndoint = ({ baseUrl = "", address, cursor, limit }) => {
+  return [baseUrl, "withdrawals", address, createQueryString({ cursor, limit })].join("/");
+};
+// Annotate the CommonJS export names for ESM import in node:
+0 && (module.exports = {
+  depositEndpoint,
+  withdrawalEndoint
+});
+//# sourceMappingURL=indexer.cjs.map
\ No newline at end of file

indexer/api-ts/indexer.cjs.map

+{"version":3,"sources":["indexer.ts"],"sourcesContent":["export * from './generated'\n\ntype PaginationOptions = {\n  limit?: number\n  cursor?: string\n}\n\ntype Options = {\n  baseUrl?: string\n  address: `0x${string}`\n} & PaginationOptions\n\nconst createQueryString = ({ cursor, limit }: PaginationOptions): string => {\n  if (cursor === undefined && limit === undefined) {\n    return ''\n  }\n  const queries: string[] = []\n  if (cursor) {\n    queries.push(`cursor=${cursor}`)\n  }\n  if (limit) {\n    queries.push(`limit=${limit}`)\n  }\n  return `?${queries.join('&')}`\n}\n\nexport const depositEndpoint = ({ baseUrl = '', address, cursor, limit }: Options): string => {\n  return [baseUrl, 'deposits', address, createQueryString({ cursor, limit })].join('/')\n}\n\nexport const withdrawalEndoint = ({ baseUrl = '', address, cursor, limit }: Options): string => {\n  return [baseUrl, 'withdrawals', address, createQueryString({ cursor, limit })].join('/')\n}\n\n"],"mappings":";;;;;;;;;;;;;;;;;;;;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAYA,IAAM,oBAAoB,CAAC,EAAE,QAAQ,MAAM,MAAiC;AAC1E,MAAI,WAAW,UAAa,UAAU,QAAW;AAC/C,WAAO;AAAA,EACT;AACA,QAAM,UAAoB,CAAC;AAC3B,MAAI,QAAQ;AACV,YAAQ,KAAK,UAAU,MAAM,EAAE;AAAA,EACjC;AACA,MAAI,OAAO;AACT,YAAQ,KAAK,SAAS,KAAK,EAAE;AAAA,EAC/B;AACA,SAAO,IAAI,QAAQ,KAAK,GAAG,CAAC;AAC9B;AAEO,IAAM,kBAAkB,CAAC,EAAE,UAAU,IAAI,SAAS,QAAQ,MAAM,MAAuB;AAC5F,SAAO,CAAC,SAAS,YAAY,SAAS,kBAAkB,EAAE,QAAQ,MAAM,CAAC,CAAC,EAAE,KAAK,GAAG;AACtF;AAEO,IAAM,oBAAoB,CAAC,EAAE,UAAU,IAAI,SAAS,QAAQ,MAAM,MAAuB;AAC9F,SAAO,CAAC,SAAS,eAAe,SAAS,kBAAkB,EAAE,QAAQ,MAAM,CAAC,CAAC,EAAE,KAAK,GAAG;AACzF;","names":[]}
\ No newline at end of file

indexer/api-ts/indexer.js

+// indexer.ts
+var createQueryString = ({ cursor, limit }) => {
+  if (cursor === void 0 && limit === void 0) {
+    return "";
+  }
+  const queries = [];
+  if (cursor) {
+    queries.push(`cursor=${cursor}`);
+  }
+  if (limit) {
+    queries.push(`limit=${limit}`);
+  }
+  return `?${queries.join("&")}`;
+};
+var depositEndpoint = ({ baseUrl = "", address, cursor, limit }) => {
+  return [baseUrl, "deposits", address, createQueryString({ cursor, limit })].join("/");
+};
+var withdrawalEndoint = ({ baseUrl = "", address, cursor, limit }) => {
+  return [baseUrl, "withdrawals", address, createQueryString({ cursor, limit })].join("/");
+};
+export {
+  depositEndpoint,
+  withdrawalEndoint
+};
+//# sourceMappingURL=indexer.js.map
\ No newline at end of file

indexer/api-ts/indexer.js.map

+{"version":3,"sources":["indexer.ts"],"sourcesContent":["export * from './generated'\n\ntype PaginationOptions = {\n  limit?: number\n  cursor?: string\n}\n\ntype Options = {\n  baseUrl?: string\n  address: `0x${string}`\n} & PaginationOptions\n\nconst createQueryString = ({ cursor, limit }: PaginationOptions): string => {\n  if (cursor === undefined && limit === undefined) {\n    return ''\n  }\n  const queries: string[] = []\n  if (cursor) {\n    queries.push(`cursor=${cursor}`)\n  }\n  if (limit) {\n    queries.push(`limit=${limit}`)\n  }\n  return `?${queries.join('&')}`\n}\n\nexport const depositEndpoint = ({ baseUrl = '', address, cursor, limit }: Options): string => {\n  return [baseUrl, 'deposits', address, createQueryString({ cursor, limit })].join('/')\n}\n\nexport const withdrawalEndoint = ({ baseUrl = '', address, cursor, limit }: Options): string => {\n  return [baseUrl, 'withdrawals', address, createQueryString({ cursor, limit })].join('/')\n}\n\n"],"mappings":";AAYA,IAAM,oBAAoB,CAAC,EAAE,QAAQ,MAAM,MAAiC;AAC1E,MAAI,WAAW,UAAa,UAAU,QAAW;AAC/C,WAAO;AAAA,EACT;AACA,QAAM,UAAoB,CAAC;AAC3B,MAAI,QAAQ;AACV,YAAQ,KAAK,UAAU,MAAM,EAAE;AAAA,EACjC;AACA,MAAI,OAAO;AACT,YAAQ,KAAK,SAAS,KAAK,EAAE;AAAA,EAC/B;AACA,SAAO,IAAI,QAAQ,KAAK,GAAG,CAAC;AAC9B;AAEO,IAAM,kBAAkB,CAAC,EAAE,UAAU,IAAI,SAAS,QAAQ,MAAM,MAAuB;AAC5F,SAAO,CAAC,SAAS,YAAY,SAAS,kBAAkB,EAAE,QAAQ,MAAM,CAAC,CAAC,EAAE,KAAK,GAAG;AACtF;AAEO,IAAM,oBAAoB,CAAC,EAAE,UAAU,IAAI,SAAS,QAAQ,MAAM,MAAuB;AAC9F,SAAO,CAAC,SAAS,eAAe,SAAS,kBAAkB,EAAE,QAAQ,MAAM,CAAC,CAAC,EAAE,KAAK,GAAG;AACzF;","names":[]}
\ No newline at end of file

indexer/api-ts/indexer.ts

+export * from './generated'
+
+type PaginationOptions = {
+  limit?: number
+  cursor?: string
+}
+
+type Options = {
+  baseUrl?: string
+  address: `0x${string}`
+} & PaginationOptions
+
+const createQueryString = ({ cursor, limit }: PaginationOptions): string => {
+  if (cursor === undefined && limit === undefined) {
+    return ''
+  }
+  const queries: string[] = []
+  if (cursor) {
+    queries.push(`cursor=${cursor}`)
+  }
+  if (limit) {
+    queries.push(`limit=${limit}`)
+  }
+  return `?${queries.join('&')}`
+}
+
+export const depositEndpoint = ({ baseUrl = '', address, cursor, limit }: Options): string => {
+  return [baseUrl, 'deposits', address, createQueryString({ cursor, limit })].join('/')
+}
+
+export const withdrawalEndoint = ({ baseUrl = '', address, cursor, limit }: Options): string => {
+  return [baseUrl, 'withdrawals', address, createQueryString({ cursor, limit })].join('/')
+}
+

indexer/api-ts/package.json

+{
+  "name": "@eth-optimism/indexer-api",
+  "version": "0.0.1",
+  "description": "[Optimism] typescript types for the indexer service",
+  "main": "indexer.cjs",
+  "module": "indexer.js",
+  "types": "indexer.ts",
+  "type": "module",
+  "files": [
+    "*.ts",
+    "*.ts",
+    "*.js",
+    "*.js.map",
+    "*.cjs",
+    "*.cjs.map",
+    "LICENSE"
+  ],
+  "scripts": {
+    "clean": "rm -rf generated.ts indexer.cjs indexer.js",
+    "generate": "npm run clean && tygo generate && mv ../api/routes/index.ts generated.ts && npx tsup"
+  },
+  "keywords": [
+    "optimism",
+    "ethereum",
+    "indexer"
+  ],
+  "homepage": "https://github.com/ethereum-optimism/optimism/tree/develop/indexer#readme",
+  "license": "MIT",
+  "author": "Optimism PBC",
+  "repository": {
+    "type": "git",
+    "url": "https://github.com/ethereum-optimism/optimism.git"
+  }}

indexer/api-ts/tsconfig.json

+{
+  "compilerOptions": {
+    "outDir": "dist",
+    "strict": true,
+    "skipLibCheck": true,
+    "module": "ESNext",
+    "moduleResolution": "bundler",
+    "jsx": "react",
+    "target": "ESNext",
+    "noEmit": true
+  },
+  "include": ["."]
+}

indexer/api-ts/tsup.config.ts

+import packageJson from './package.json'
+
+export default {
+  name: packageJson.name,
+  entry: ['indexer.ts'],
+  outDir: '.',
+  format: ['esm', 'cjs'],
+  splitting: false,
+  sourcemap: true,
+  clean: false,
+}

indexer/api-ts/tygo.yaml

+packages:
+  - path: "github.com/ethereum-optimism/optimism/indexer/api/routes"

pnpm-workspace.yaml

@@ -2,3 +2,4 @@ packages:
   - 'packages/*'
   - 'endpoint-monitor'
   - 'op-exporter'
+  - 'indexer/ts'