signet.js 0.0.7 → 0.0.9

package/src/utils/publicKey.ts

@@ -1,17 +0,0 @@
-import { CONTRACT_ADDRESSES, ROOT_PUBLIC_KEYS, type CHAINS } from '@constants'
-import type { NajPublicKey } from '@types'
-
-export const getRootPublicKey = (
-  contractAddress: string,
-  chain: keyof typeof CHAINS
-): NajPublicKey | undefined => {
-  const environment = Object.entries(CONTRACT_ADDRESSES[chain]).find(
-    ([_, address]) => address.toLowerCase() === contractAddress.toLowerCase()
-  )?.[0] as keyof typeof ROOT_PUBLIC_KEYS | undefined
-
-  if (environment) {
-    return ROOT_PUBLIC_KEYS[environment]
-  }
-
-  return undefined
-}

package/tsconfig.eslint.json

@@ -1,8 +0,0 @@
-{
-  "compilerOptions": {
-    "allowJs": true,
-    "noEmit": true,
-    "types": ["@types/node"]
-  },
-  "include": [".eslintrc.cjs", "src/**/*.ts", "tsup.config.ts"]
-}

package/tsconfig.json

@@ -1,126 +0,0 @@
-{
-  "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": "ES2020" /* 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": "ESNext" /* Specify what module code is generated. */,
-    // "rootDir": "./",                                  /* Specify the root folder within your source files. */
-    "moduleResolution": "bundler" /* Specify how TypeScript looks up a file from a given module specifier. */,
-    // "baseUrl": "./",                                  /* Specify the base directory to resolve non-relative module names. */
-    "paths": {
-      "@chain-adapters": ["./src/chain-adapters/index.ts"],
-      "@contracts": ["./src/contracts/index.ts"],
-      "@utils": ["./src/utils/index.ts"],
-      "@constants": ["./src/constants.ts"],
-      "@types": ["./src/types.ts"],
-      "@chain-adapters/*": ["./src/chain-adapters/*"],
-      "@contracts/*": ["./src/contracts/*"],
-      "@utils/*": ["./src/utils/*"]
-    } /* 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. */
-    "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 '<reference>'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. */
-    // "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": "./dist" /* Specify an output folder for all emitted files. */,
-    // "removeComments": true,                           /* Disable emitting comments. */
-    // "noEmit": true,                                   /* Disable emitting files from a compilation. */
-    // "importHelpers": true,                            /* Allow importing helper functions from tslib once per project, instead of including them per-file. */
-    // "importsNotUsedAsValues": "remove",               /* Specify emit/checking behavior for imports that are only used for types. */
-    // "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. */
-    // "preserveValueImports": true,                     /* Preserve unused imported values in the JavaScript output that would otherwise be removed. */
-
-    /* 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. */
-    // "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. */
-    // "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. */
-  },
-  "include": [
-    "src/**/*.ts",
-    "src/**/*.d.ts",
-    "hardhat.config.mts",
-    "vitest.config.ts",
-    "tsup.config.ts"
-  ],
-  "exclude": ["**/*.test.ts", "**/*.spec.ts", "node_modules", "dist"]
-}

package/tsup.config.ts

@@ -1,58 +0,0 @@
-import { resolve } from 'path'
-
-import { defineConfig } from 'tsup'
-import type { Options } from 'tsup'
-
-export default defineConfig((options) => {
-  const isNode = options.env?.TARGET === 'node'
-  const isBrowser = options.env?.TARGET === 'browser'
-
-  if (!isNode && !isBrowser) {
-    throw new Error(
-      'TARGET environment variable must be set to either "node" or "browser"'
-    )
-  }
-
-  const target = isNode ? 'node18' : 'esnext'
-  const platform = isNode ? 'node' : 'browser'
-  const outDir = `dist/${platform}`
-
-  const config: Options = {
-    entry: ['src/index.ts'],
-    format: ['esm', 'cjs'],
-    target,
-    platform,
-    outDir,
-    outExtension({ format }) {
-      return {
-        js: format === 'esm' ? `.${platform}.js` : `.${platform}.cjs`,
-      }
-    },
-    sourcemap: true,
-    minify: true,
-    clean: true,
-    dts: isNode,
-    external: isNode
-      ? ['path', 'fs', 'crypto', 'stream', 'util', 'events', 'buffer']
-      : ['crypto', 'stream', 'util', 'events', 'buffer'],
-    treeshake: true,
-    splitting: false,
-    esbuildOptions(options) {
-      options.conditions = isNode
-        ? ['node', 'import', 'default']
-        : ['browser', 'import', 'default']
-      options.mainFields = isNode
-        ? ['module', 'main']
-        : ['browser', 'module', 'main']
-      options.alias = {
-        '@chain-adapters': resolve(__dirname, './src/chain-adapters'),
-        '@contracts': resolve(__dirname, './src/contracts'),
-        '@utils': resolve(__dirname, './src/utils'),
-        '@constants': resolve(__dirname, './src/constants.ts'),
-        '@types': resolve(__dirname, './src/types.ts'),
-      }
-    },
-  }
-
-  return config
-})

package/vitest.config.ts

@@ -1,19 +0,0 @@
-import { resolve } from 'path'
-
-import { defineConfig } from 'vitest/config'
-
-export default defineConfig({
-  test: {
-    globals: true,
-    environment: 'node',
-  },
-  resolve: {
-    alias: {
-      '@chain-adapters': resolve(__dirname, './src/chain-adapters'),
-      '@contracts': resolve(__dirname, './src/contracts'),
-      '@utils': resolve(__dirname, './src/utils'),
-      '@constants': resolve(__dirname, './src/constants.ts'),
-      '@types': resolve(__dirname, './src/types.ts'),
-    },
-  },
-})

package/vocs.config.ts

@@ -1,213 +0,0 @@
-import { defineConfig, type Config } from 'vocs'
-
-export default defineConfig({
-  title: 'Sig Network',
-  description:
-    'Manage and use cryptographic key(s) across multiple chains or multiple contexts, with on-chain-enforced conditions',
-  twoslash: {
-    compilerOptions: {
-      strict: true,
-      paths: {
-        'signet.js': ['./src'],
-        '@chain-adapters': ['./src/chain-adapters/index.ts'],
-        '@contracts': ['./src/contracts/index.ts'],
-        '@utils': ['./src/utils/index.ts'],
-        '@constants': ['./src/constants.ts'],
-        '@types': ['./src/types.ts'],
-        '@chain-adapters/*': ['./src/chain-adapters/*'],
-        '@contracts/*': ['./src/contracts/*'],
-        '@utils/*': ['./src/utils/*'],
-      },
-    },
-  },
-  logoUrl: 'signet-logo.png',
-  iconUrl: 'signet-logo.png',
-  sidebar: [
-    {
-      text: 'Introduction',
-      items: [
-        { text: 'Introduction to Chain Signatures', link: '/' },
-        {
-          text: 'Signet.js Quickstart',
-          link: '/introduction/signet-quick-start',
-        },
-      ],
-    },
-    {
-      text: 'Primitives',
-      items: [
-        { text: 'Contract Addresses', link: '/primitives/contract-addresses' },
-        {
-          text: 'Chain Adapter Interface',
-          link: '/primitives/chain-adapter-interface',
-        },
-        {
-          text: 'Chain Contract Interfaces',
-          link: '/primitives/chain-contract-interface',
-        },
-      ],
-    },
-    {
-      text: 'Examples',
-      items: [
-        { text: 'Sign arbitrary hash', link: '/examples/arbitrary-hash' },
-        {
-          text: 'Use Ethereum chain signatures to securely sponsor gas fees for calling your Base smart contract',
-          link: '/examples/sponsor-foreign-chain-gas',
-        },
-      ],
-    },
-    {
-      text: 'API Reference',
-      items: [
-        {
-          text: 'Chain Adapters',
-          items: [
-            {
-              text: 'EVM Chains',
-              items: [
-                { text: 'Overview', link: '/signetjs/chain-adapters/evm' },
-                {
-                  text: 'prepareTransactionForSigning',
-                  link: '/signetjs/chain-adapters/evm/prepare-transaction-for-signing',
-                },
-                {
-                  text: 'finalizeTransactionSigning',
-                  link: '/signetjs/chain-adapters/evm/finalize-transaction-signing',
-                },
-                {
-                  text: 'prepareMessageForSigning',
-                  link: '/signetjs/chain-adapters/evm/prepare-message-for-signing',
-                },
-                {
-                  text: 'finalizeMessageSigning',
-                  link: '/signetjs/chain-adapters/evm/finalize-message-signing',
-                },
-                {
-                  text: 'prepareTypedDataForSigning',
-                  link: '/signetjs/chain-adapters/evm/prepare-typed-data-for-signing',
-                },
-                {
-                  text: 'finalizeTypedDataSigning',
-                  link: '/signetjs/chain-adapters/evm/finalize-typed-data-signing',
-                },
-              ],
-            },
-            {
-              text: 'Bitcoin',
-              items: [
-                { text: 'Overview', link: '/signetjs/chain-adapters/bitcoin' },
-                {
-                  text: 'RPC Adapter',
-                  link: '/signetjs/chain-adapters/bitcoin/btc-rpc-adapter',
-                },
-                {
-                  text: 'prepareTransactionForSigning',
-                  link: '/signetjs/chain-adapters/bitcoin/prepare-transaction-for-signing',
-                },
-                {
-                  text: 'finalizeTransactionSigning',
-                  link: '/signetjs/chain-adapters/bitcoin/finalize-transaction-signing',
-                },
-              ],
-            },
-            {
-              text: 'Cosmos Chains',
-              items: [
-                { text: 'Overview', link: '/signetjs/chain-adapters/cosmos' },
-                {
-                  text: 'prepareTransactionForSigning',
-                  link: '/signetjs/chain-adapters/cosmos/prepare-transaction-for-signing',
-                },
-                {
-                  text: 'finalizeTransactionSigning',
-                  link: '/signetjs/chain-adapters/cosmos/finalize-transaction-signing',
-                },
-              ],
-            },
-            {
-              text: 'deriveAddressAndPublicKey',
-              link: '/signetjs/chain-adapters/derive-address-and-public-key',
-            },
-            {
-              text: 'getBalance',
-              link: '/signetjs/chain-adapters/get-balance',
-            },
-            {
-              text: 'broadcastTx',
-              link: '/signetjs/chain-adapters/broadcast-tx',
-            },
-          ],
-        },
-        {
-          text: 'Contracts',
-          items: [
-            {
-              text: 'EVM',
-              items: [
-                {
-                  text: 'constructor',
-                  link: '/signetjs/contracts/evm/constructor',
-                },
-                {
-                  text: 'getCurrentSignatureDeposit',
-                  link: '/signetjs/contracts/evm/get-current-signature-deposit',
-                },
-                {
-                  text: 'getDerivedPublicKey',
-                  link: '/signetjs/contracts/evm/get-derived-public-key',
-                },
-                {
-                  text: 'getPublicKey',
-                  link: '/signetjs/contracts/evm/get-public-key',
-                },
-                {
-                  text: 'getLatestKeyVersion',
-                  link: '/signetjs/contracts/evm/get-latest-key-version',
-                },
-                { text: 'sign', link: '/signetjs/contracts/evm/sign' },
-              ],
-            },
-            {
-              text: 'NEAR',
-              items: [
-                {
-                  text: 'constructor',
-                  link: '/signetjs/contracts/near/constructor',
-                },
-                {
-                  text: 'getCurrentSignatureDeposit',
-                  link: '/signetjs/contracts/near/get-current-signature-deposit',
-                },
-                {
-                  text: 'getDerivedPublicKey',
-                  link: '/signetjs/contracts/near/get-derived-public-key',
-                },
-                {
-                  text: 'getPublicKey',
-                  link: '/signetjs/contracts/near/get-public-key',
-                },
-                {
-                  text: 'sign',
-                  link: '/signetjs/contracts/near/sign',
-                },
-              ],
-            },
-          ],
-        },
-      ],
-    },
-  ],
-  socials: [
-    {
-      icon: 'github',
-      link: 'https://github.com/sig-net',
-    },
-  ],
-  theme: {
-    accentColor: {
-      light: '#00C08B',
-      dark: '#00E6A6',
-    },
-  },
-}) as Config