types-js's Introduction

Starknet types JS/TS

🐺 Starknet TypeScript types 🚀

Shared TypeScript type definitions for Starknet projects

Installation

npm i @starknet-io/types-js

Types

API Starknet JSON RPC Specification

  // type import
  import type { SomeApiType } from '@starknet-io/types-js'
  // or entire namespace import
  import { API } from '@starknet-io/types-js'

Wallet API Wallet JSON RPC Specification

  // type import
  import type { SomeWalletApiType } from '@starknet-io/types-js'
  // or entire namespace import
  import { WALLET_API } from '@starknet-io/types-js'

SNIP-12 Hashing and signing typed structured data

/src/wallet-api/typedData.ts

Versioning (pending SPEC PR merge)

(MAJOR.MINOR) Version of this package should follow starknet-spec semantic versioning. PATCH version can diverge based on bug-fixes ex. Starknet types v0.7.x <-> Starknet Spec v0.7.x

Devs Build

npm run build

Devs Testing

npm run lint

License

This repository is licensed under the MIT License, see LICENSE for more information.

types-js's People

Contributors

Stargazers

Watchers

types-js's Issues

BUG : problem of library import

Describe the bug
When using this lib in ts-node, I have a compilation message error :

TSError: ⨯ Unable to compile TypeScript:
src/tmp/26.testSepolia.ts:12:28 - error TS1479: 
The current file is a CommonJS module whose imports will produce 'require' calls; 
however, the referenced file is an ECMAScript module and cannot be imported with 'require'. 
Consider writing a dynamic 'import("starknet-types")' call instead.
  To convert this file to an ECMAScript module, change its file extension to '.mts', 
or add the field `"type": "module"` to '/home/edmond/Documents/starknet/starknet.js-workshop-typescript/package.json'.

12 import { WALLET_API } from "starknet-types";
                              ~~~~~~~~~~~~~~~~

To Reproduce

create a TS script, including :

import { WALLET_API } from "starknet-types";

using this package.json :

{
  "name": "starknet-js-typescript",
  "version": "1.0.0",
  "description": "",
  "main": "index.js",
  "scripts": {
    "test": "jest",
  },
  "keywords": [],
  "author": "",
  "license": "ISC",
  "dependencies": {
    "starknet": "6.9.0",
    "starknet-merkle-tree": "^1.0.2",
    "starknet-types": "^0.7.2",
  },
  "devDependencies": {
    "ts-node": "^10.9.2",
    "typescript": "^5.3.3"
  }
}

and this tsconfig.json :

{
  "compilerOptions": {
    "target":"ES2022",
    "lib": [
      "es2022",
      "dom"
    ],
    "outDir": "./out",
    "rootDir": "./src",
    "incremental": true,
    "module": "Node16",
    "moduleResolution": "Node16",
    "resolveJsonModule": true,
    "strict": true,
    "esModuleInterop": true,
    "sourceMap": true,
    "isolatedModules": true,
  },
  "include": [
    "src/**/*"
  ],
  "exclude": [
    "node_modules"
  ]
}