Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

fix: readme #10

Merged
merged 2 commits into from
Jun 4, 2024
Merged

fix: readme #10

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
7f3dd58
fix: readme
tabaktoni Jun 4, 2024
e3abc77
ci: remove duplicate CI release
tabaktoni Jun 4, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
31 changes: 0 additions & 31 deletions .github/workflows/_release.yml
View file
Open in desktop

This file was deleted.

21 changes: 0 additions & 21 deletions .github/workflows/manual-release.yml
View file
Open in desktop

This file was deleted.

42 changes: 17 additions & 25 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
# starknet-types
# Starknet types JS/TS

🐺 Starknet TypeScript types 🚀

Expand All @@ -8,28 +8,28 @@

Shared TypeScript type definitions for Starknet projects

## Types
## Installation

#### api [Starknet JSON RPC Specification](https://github.com/starkware-libs/starknet-specs/tree/master/api)
- /src/api/*
- usage
```ts
import type { SomeType } from 'starknet-types'
```
- or usage from api namespace import
```ts
import { API } from 'starknet-types'
```bash
npm i @starknet-io/types-js
```

#### wallet-api [Wallet JSON RPC Specification](https://github.com/starkware-libs/starknet-specs/tree/48e77bf4aaf687388b40b8198e3105401941517a/wallet-api)
- /src/wallet-api/*
- usage from top level type import
## Types

#### API [Starknet JSON RPC Specification](https://github.com/starkware-libs/starknet-specs/tree/master/api)
```ts
import type { SomeType } from 'starknet-types'
// type import
import type { SomeApiType } from '@starknet-io/types-js'
// or entire namespace import
import { API } from '@starknet-io/types-js'
```
- or usage from api namespace import

#### Wallet API [Wallet JSON RPC Specification](https://github.com/starkware-libs/starknet-specs/tree/48e77bf4aaf687388b40b8198e3105401941517a/wallet-api)
```ts
import { WALLET_API } from 'starknet-types'
// 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](https://github.com/starknet-io/SNIPs/blob/main/SNIPS/snip-12.md)
Expand All @@ -41,14 +41,6 @@ Shared TypeScript type definitions for Starknet projects
PATCH version can diverge based on bug-fixes
ex. Starknet types v0.7.x <-> Starknet Spec v0.7.x

## Usage

As a package

```bash
npm i starknet-types
```

## Devs Build

```bash
Expand Down