From 7f4747210e4b06b9b4d374861a96043946517f83 Mon Sep 17 00:00:00 2001 From: paulelisha Date: Fri, 8 Nov 2024 17:07:13 +0100 Subject: [PATCH] kaiascan sdk ts --- .env.example | 0 .gitignore | 0 config.example.ts | 5 +++ kaiascan_test.ts | 13 ++++++ package.json | 11 +++++ src/kaiascan.ts | 102 ++++++++++++++++++++++++++++++++++++++++++ tsconfig.json | 110 ++++++++++++++++++++++++++++++++++++++++++++++ 7 files changed, 241 insertions(+) create mode 100644 .env.example create mode 100644 .gitignore create mode 100644 config.example.ts create mode 100644 kaiascan_test.ts create mode 100644 package.json create mode 100644 src/kaiascan.ts create mode 100644 tsconfig.json diff --git a/.env.example b/.env.example new file mode 100644 index 0000000..e69de29 diff --git a/.gitignore b/.gitignore new file mode 100644 index 0000000..e69de29 diff --git a/config.example.ts b/config.example.ts new file mode 100644 index 0000000..eefaac2 --- /dev/null +++ b/config.example.ts @@ -0,0 +1,5 @@ +export const Config = { + apiKey: "INSERT_API_KEY", + address: "INSERT_ADDRESS", + test2: ["INSERT_ADDRESS_1", "INSERT_ADDRESS_2"] +} \ No newline at end of file diff --git a/kaiascan_test.ts b/kaiascan_test.ts new file mode 100644 index 0000000..bb64e1e --- /dev/null +++ b/kaiascan_test.ts @@ -0,0 +1,13 @@ + +import { Config } from './config.example'; +import { KaiascanSDK } from './src/kaiascan'; + +const sdk = new KaiascanSDK(); + +sdk.getFungibleToken(Config.address) + .then(response => console.log("Token Info:", response)) + .catch(error => console.error("Error:", error)); + +sdk.getLatestBlock() + .then(response => console.log("Latest Block:", response)) + .catch(error => console.error("Error:", error)); diff --git a/package.json b/package.json new file mode 100644 index 0000000..926cf97 --- /dev/null +++ b/package.json @@ -0,0 +1,11 @@ +{ + "name": "kaiascan-sdk-ts", + "version": "1.0.0", + "main": "index.js", + "scripts": { + "test": "echo \"Error: no test specified\" && exit 1" + }, + "author": "", + "license": "ISC", + "description": "" +} diff --git a/src/kaiascan.ts b/src/kaiascan.ts new file mode 100644 index 0000000..526fbe7 --- /dev/null +++ b/src/kaiascan.ts @@ -0,0 +1,102 @@ +type Address = string; + +interface ApiResponse { + code: number; + data: T; + msg: string; +} + +interface TokenInfo { + contractType: string; + name: string; + symbol: string; + icon: string; + decimal: number; + totalSupply: number; + totalTransfers: number; + officialSite: string; + burnAmount: number; + totalBurns: number; +} + +export class KaiascanSDK { + private readonly BASE_URL = "https://mainnet-oapi.kaiascan.io/"; + private readonly CHAIN_ID = "8217"; + private readonly tokensEndpoint = "api/v1/tokens"; + private readonly nftsEndpoint = "api/v1/nfts"; + + private async fetchApi(url: string): Promise> { + try { + const response = await fetch(`${this.BASE_URL}${url}`, { + method: "GET", + headers: { + "Content-Type": "application/json", + }, + }); + + if (!response.ok) { + throw new Error(`HTTP error! status: ${response.status}`); + } + + const apiResponse: ApiResponse = await response.json(); + + if (apiResponse.code !== 0) { + throw new Error(`API error! code: ${apiResponse.code}, message: ${apiResponse.msg}`); + } + + return apiResponse; + } catch (error) { + throw new Error(`Error making request to ${url}: ${error}`); + } + } + + public async getFungibleToken(tokenAddress: Address): Promise> { + const url = `${this.tokensEndpoint}?tokenAddress=${encodeURIComponent(tokenAddress)}`; + return this.fetchApi(url); + } + + public async getNftItem(nftAddress: Address, tokenId: string): Promise> { + const url = `${this.nftsEndpoint}?nftAddress=${encodeURIComponent(nftAddress)}&tokenId=${encodeURIComponent(tokenId)}`; + return this.fetchApi(url); + } + + public async getContractCreationCode(contractAddress: Address): Promise> { + const url = `api/v1/contracts/creation-code?contractAddress=${encodeURIComponent(contractAddress)}`; + return this.fetchApi(url); + } + + public async getLatestBlock(): Promise> { + const url = `api/v1/blocks/latest`; + return this.fetchApi(url); + } + + public async getBlock(blockNumber: number): Promise> { + const url = `api/v1/blocks?blockNumber=${blockNumber}`; + return this.fetchApi(url); + } + + public async getBlocks(): Promise> { + const url = `api/v1/blocks`; + return this.fetchApi(url); + } + + public async getTransactionsOfBlock(blockNumber: number): Promise> { + const url = `api/v1/blocks/${blockNumber}/transactions`; + return this.fetchApi(url); + } + + public async getTransactionReceiptStatus(transactionHash: string): Promise> { + const url = `api/v1/transaction-receipts/status?transactionHash=${encodeURIComponent(transactionHash)}`; + return this.fetchApi(url); + } + + public async getTransaction(transactionHash: string): Promise> { + const url = `api/v1/transactions/${encodeURIComponent(transactionHash)}`; + return this.fetchApi(url); + } + + public async getContractSourceCode(contractAddress: Address): Promise> { + const url = `api/v1/contracts/source-code?contractAddress=${encodeURIComponent(contractAddress)}`; + return this.fetchApi(url); + } +} diff --git a/tsconfig.json b/tsconfig.json new file mode 100644 index 0000000..56a8ab8 --- /dev/null +++ b/tsconfig.json @@ -0,0 +1,110 @@ +{ + "compilerOptions": { + /* Visit https://aka.ms/tsconfig to read more about this file */ + + /* Projects */ + // "incremental": true, /* Save .tsbuildinfo files to allow for incremental compilation of projects. */ + // "composite": true, /* Enable constraints that allow a TypeScript project to be used with project references. */ + // "tsBuildInfoFile": "./.tsbuildinfo", /* Specify the path to .tsbuildinfo incremental compilation file. */ + // "disableSourceOfProjectReferenceRedirect": true, /* Disable preferring source files instead of declaration files when referencing composite projects. */ + // "disableSolutionSearching": true, /* Opt a project out of multi-project reference checking when editing. */ + // "disableReferencedProjectLoad": true, /* Reduce the number of projects loaded automatically by TypeScript. */ + + /* Language and Environment */ + "target": "es2016", /* Set the JavaScript language version for emitted JavaScript and include compatible library declarations. */ + // "lib": [], /* Specify a set of bundled library declaration files that describe the target runtime environment. */ + // "jsx": "preserve", /* Specify what JSX code is generated. */ + // "experimentalDecorators": true, /* Enable experimental support for legacy experimental decorators. */ + // "emitDecoratorMetadata": true, /* Emit design-type metadata for decorated declarations in source files. */ + // "jsxFactory": "", /* Specify the JSX factory function used when targeting React JSX emit, e.g. 'React.createElement' or 'h'. */ + // "jsxFragmentFactory": "", /* Specify the JSX Fragment reference used for fragments when targeting React JSX emit e.g. 'React.Fragment' or 'Fragment'. */ + // "jsxImportSource": "", /* Specify module specifier used to import the JSX factory functions when using 'jsx: react-jsx*'. */ + // "reactNamespace": "", /* Specify the object invoked for 'createElement'. This only applies when targeting 'react' JSX emit. */ + // "noLib": true, /* Disable including any library files, including the default lib.d.ts. */ + // "useDefineForClassFields": true, /* Emit ECMAScript-standard-compliant class fields. */ + // "moduleDetection": "auto", /* Control what method is used to detect module-format JS files. */ + + /* Modules */ + "module": "commonjs", /* Specify what module code is generated. */ + // "rootDir": "./", /* Specify the root folder within your source files. */ + // "moduleResolution": "node10", /* Specify how TypeScript looks up a file from a given module specifier. */ + // "baseUrl": "./", /* Specify the base directory to resolve non-relative module names. */ + // "paths": {}, /* Specify a set of entries that re-map imports to additional lookup locations. */ + // "rootDirs": [], /* Allow multiple folders to be treated as one when resolving modules. */ + // "typeRoots": [], /* Specify multiple folders that act like './node_modules/@types'. */ + // "types": [], /* Specify type package names to be included without being referenced in a source file. */ + // "allowUmdGlobalAccess": true, /* Allow accessing UMD globals from modules. */ + // "moduleSuffixes": [], /* List of file name suffixes to search when resolving a module. */ + // "allowImportingTsExtensions": true, /* Allow imports to include TypeScript file extensions. Requires '--moduleResolution bundler' and either '--noEmit' or '--emitDeclarationOnly' to be set. */ + // "resolvePackageJsonExports": true, /* Use the package.json 'exports' field when resolving package imports. */ + // "resolvePackageJsonImports": true, /* Use the package.json 'imports' field when resolving imports. */ + // "customConditions": [], /* Conditions to set in addition to the resolver-specific defaults when resolving imports. */ + // "noUncheckedSideEffectImports": true, /* Check side effect imports. */ + // "resolveJsonModule": true, /* Enable importing .json files. */ + // "allowArbitraryExtensions": true, /* Enable importing files with any extension, provided a declaration file is present. */ + // "noResolve": true, /* Disallow 'import's, 'require's or ''s from expanding the number of files TypeScript should add to a project. */ + + /* JavaScript Support */ + // "allowJs": true, /* Allow JavaScript files to be a part of your program. Use the 'checkJS' option to get errors from these files. */ + // "checkJs": true, /* Enable error reporting in type-checked JavaScript files. */ + // "maxNodeModuleJsDepth": 1, /* Specify the maximum folder depth used for checking JavaScript files from 'node_modules'. Only applicable with 'allowJs'. */ + + /* Emit */ + // "declaration": true, /* Generate .d.ts files from TypeScript and JavaScript files in your project. */ + // "declarationMap": true, /* Create sourcemaps for d.ts files. */ + // "emitDeclarationOnly": true, /* Only output d.ts files and not JavaScript files. */ + // "sourceMap": true, /* Create source map files for emitted JavaScript files. */ + // "inlineSourceMap": true, /* Include sourcemap files inside the emitted JavaScript. */ + // "noEmit": true, /* Disable emitting files from a compilation. */ + // "outFile": "./", /* Specify a file that bundles all outputs into one JavaScript file. If 'declaration' is true, also designates a file that bundles all .d.ts output. */ + // "outDir": "./", /* Specify an output folder for all emitted files. */ + // "removeComments": true, /* Disable emitting comments. */ + // "importHelpers": true, /* Allow importing helper functions from tslib once per project, instead of including them per-file. */ + // "downlevelIteration": true, /* Emit more compliant, but verbose and less performant JavaScript for iteration. */ + // "sourceRoot": "", /* Specify the root path for debuggers to find the reference source code. */ + // "mapRoot": "", /* Specify the location where debugger should locate map files instead of generated locations. */ + // "inlineSources": true, /* Include source code in the sourcemaps inside the emitted JavaScript. */ + // "emitBOM": true, /* Emit a UTF-8 Byte Order Mark (BOM) in the beginning of output files. */ + // "newLine": "crlf", /* Set the newline character for emitting files. */ + // "stripInternal": true, /* Disable emitting declarations that have '@internal' in their JSDoc comments. */ + // "noEmitHelpers": true, /* Disable generating custom helper functions like '__extends' in compiled output. */ + // "noEmitOnError": true, /* Disable emitting files if any type checking errors are reported. */ + // "preserveConstEnums": true, /* Disable erasing 'const enum' declarations in generated code. */ + // "declarationDir": "./", /* Specify the output directory for generated declaration files. */ + + /* Interop Constraints */ + // "isolatedModules": true, /* Ensure that each file can be safely transpiled without relying on other imports. */ + // "verbatimModuleSyntax": true, /* Do not transform or elide any imports or exports not marked as type-only, ensuring they are written in the output file's format based on the 'module' setting. */ + // "isolatedDeclarations": true, /* Require sufficient annotation on exports so other tools can trivially generate declaration files. */ + // "allowSyntheticDefaultImports": true, /* Allow 'import x from y' when a module doesn't have a default export. */ + "esModuleInterop": true, /* Emit additional JavaScript to ease support for importing CommonJS modules. This enables 'allowSyntheticDefaultImports' for type compatibility. */ + // "preserveSymlinks": true, /* Disable resolving symlinks to their realpath. This correlates to the same flag in node. */ + "forceConsistentCasingInFileNames": true, /* Ensure that casing is correct in imports. */ + + /* Type Checking */ + "strict": true, /* Enable all strict type-checking options. */ + // "noImplicitAny": true, /* Enable error reporting for expressions and declarations with an implied 'any' type. */ + // "strictNullChecks": true, /* When type checking, take into account 'null' and 'undefined'. */ + // "strictFunctionTypes": true, /* When assigning functions, check to ensure parameters and the return values are subtype-compatible. */ + // "strictBindCallApply": true, /* Check that the arguments for 'bind', 'call', and 'apply' methods match the original function. */ + // "strictPropertyInitialization": true, /* Check for class properties that are declared but not set in the constructor. */ + // "strictBuiltinIteratorReturn": true, /* Built-in iterators are instantiated with a 'TReturn' type of 'undefined' instead of 'any'. */ + // "noImplicitThis": true, /* Enable error reporting when 'this' is given the type 'any'. */ + // "useUnknownInCatchVariables": true, /* Default catch clause variables as 'unknown' instead of 'any'. */ + // "alwaysStrict": true, /* Ensure 'use strict' is always emitted. */ + // "noUnusedLocals": true, /* Enable error reporting when local variables aren't read. */ + // "noUnusedParameters": true, /* Raise an error when a function parameter isn't read. */ + // "exactOptionalPropertyTypes": true, /* Interpret optional property types as written, rather than adding 'undefined'. */ + // "noImplicitReturns": true, /* Enable error reporting for codepaths that do not explicitly return in a function. */ + // "noFallthroughCasesInSwitch": true, /* Enable error reporting for fallthrough cases in switch statements. */ + // "noUncheckedIndexedAccess": true, /* Add 'undefined' to a type when accessed using an index. */ + // "noImplicitOverride": true, /* Ensure overriding members in derived classes are marked with an override modifier. */ + // "noPropertyAccessFromIndexSignature": true, /* Enforces using indexed accessors for keys declared using an indexed type. */ + // "allowUnusedLabels": true, /* Disable error reporting for unused labels. */ + // "allowUnreachableCode": true, /* Disable error reporting for unreachable code. */ + + /* Completeness */ + // "skipDefaultLibCheck": true, /* Skip type checking .d.ts files that are included with TypeScript. */ + "skipLibCheck": true /* Skip type checking all .d.ts files. */ + } +}