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.

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

(RPC 0.8.x) Beta -> Main #21

Open
wants to merge 11 commits into
base: main
Choose a base branch
from
2 changes: 1 addition & 1 deletion .github/workflows/publish.yml
Original file line number Diff line number Diff line change
Expand Up @@ -35,7 +35,7 @@ jobs:

publish:
runs-on: ubuntu-latest
if: ${{ github.ref == 'refs/heads/main' }}
if: ${{ github.ref == 'refs/heads/main' || github.ref == 'refs/heads/beta' }}
needs: [quality]
steps:
- uses: actions/checkout@v4
Expand Down
45 changes: 35 additions & 10 deletions CHANGELOG.md
Original file line number Diff line number Diff line change
@@ -1,34 +1,59 @@
## [0.7.7](https://github.com/starknet-io/types-js/compare/v0.7.6...v0.7.7) (2024-06-10)
# [0.8.0-beta.4](https://github.com/starknet-io/types-js/compare/v0.8.0-beta.3...v0.8.0-beta.4) (2024-11-26)


### Bug Fixes

* export all from abi ([#16](https://github.com/starknet-io/types-js/issues/16)) ([8dcc198](https://github.com/starknet-io/types-js/commit/8dcc198526d6561ce967407aa2ca68e378e2c300))
* beta update ([d10b199](https://github.com/starknet-io/types-js/commit/d10b199346dedda1f37073405cef428f46d63a7d))

## [0.7.6](https://github.com/starknet-io/types-js/compare/v0.7.5...v0.7.6) (2024-06-07)
# [0.8.0-beta.3](https://github.com/starknet-io/types-js/compare/v0.8.0-beta.2...v0.8.0-beta.3) (2024-11-26)


### Bug Fixes

* simgflag ([#15](https://github.com/starknet-io/types-js/issues/15)) ([f3458b9](https://github.com/starknet-io/types-js/commit/f3458b9ae436e0fe61684f8bd3dd5ce09d70e45a))
* spec to 0.8.0 rc1 ([faa86db](https://github.com/starknet-io/types-js/commit/faa86db6c67124deccbbe3daf6687352627fbe28))

## [0.7.5](https://github.com/starknet-io/types-js/compare/v0.7.4...v0.7.5) (2024-06-05)
# [0.8.0-beta.2](https://github.com/starknet-io/types-js/compare/v0.8.0-beta.1...v0.8.0-beta.2) (2024-11-25)


### Bug Fixes

* export abi internals ([#11](https://github.com/starknet-io/types-js/issues/11)) ([d22b5de](https://github.com/starknet-io/types-js/commit/d22b5decb6847ad70738ba7ea60de01281760427))
* proposed changes on exports ([#23](https://github.com/starknet-io/types-js/issues/23)) ([5e966b9](https://github.com/starknet-io/types-js/commit/5e966b90126d5054bf519f09575271d04e4ffc25))
* Update spec to 0.8.0 rc1 ([#22](https://github.com/starknet-io/types-js/issues/22)) ([8016199](https://github.com/starknet-io/types-js/commit/80161996d4f072e36a6f65f50ca58a57bd4b0d0a))

## [0.7.4](https://github.com/starknet-io/types-js/compare/v0.7.3...v0.7.4) (2024-06-04)
# [0.8.0-beta.1](https://github.com/starknet-io/types-js/compare/v0.7.7...v0.8.0-beta.1) (2024-10-28)


### Features

* beta release ([e830783](https://github.com/starknet-io/types-js/commit/e830783ed5501d6b78ed737c229a132b16f91a39))
* rpc spec 0.8.rc0 implementation, with known issues ([#19](https://github.com/starknet-io/types-js/issues/19)) ([d0bc541](https://github.com/starknet-io/types-js/commit/d0bc54162ef42c39a0665c7fc76b2e7fb4c22b80))

## [0.7.7](https://github.com/starknet-io/types-js/compare/v0.7.6...v0.7.7) (2024-06-10)

### Bug Fixes

* readme ([#10](https://github.com/starknet-io/types-js/issues/10)) ([2636265](https://github.com/starknet-io/types-js/commit/2636265000a723ec39ff71a18ec70e19e4cfc0de))
- export all from abi ([#16](https://github.com/starknet-io/types-js/issues/16)) ([8dcc198](https://github.com/starknet-io/types-js/commit/8dcc198526d6561ce967407aa2ca68e378e2c300))

## [0.7.3](https://github.com/starknet-io/types-js/compare/v0.7.2...v0.7.3) (2024-06-04)
## [0.7.6](https://github.com/starknet-io/types-js/compare/v0.7.5...v0.7.6) (2024-06-07)

### Bug Fixes

- simgflag ([#15](https://github.com/starknet-io/types-js/issues/15)) ([f3458b9](https://github.com/starknet-io/types-js/commit/f3458b9ae436e0fe61684f8bd3dd5ce09d70e45a))

## [0.7.5](https://github.com/starknet-io/types-js/compare/v0.7.4...v0.7.5) (2024-06-05)

### Bug Fixes

- export abi internals ([#11](https://github.com/starknet-io/types-js/issues/11)) ([d22b5de](https://github.com/starknet-io/types-js/commit/d22b5decb6847ad70738ba7ea60de01281760427))

## [0.7.4](https://github.com/starknet-io/types-js/compare/v0.7.3...v0.7.4) (2024-06-04)

### Bug Fixes

- readme ([#10](https://github.com/starknet-io/types-js/issues/10)) ([2636265](https://github.com/starknet-io/types-js/commit/2636265000a723ec39ff71a18ec70e19e4cfc0de))

## [0.7.3](https://github.com/starknet-io/types-js/compare/v0.7.2...v0.7.3) (2024-06-04)

### Bug Fixes

* spec update ([#7](https://github.com/starknet-io/types-js/issues/7)) ([5ec8208](https://github.com/starknet-io/types-js/commit/5ec8208f9e495f34472834e01458f4d3f97049d7))
- spec update ([#7](https://github.com/starknet-io/types-js/issues/7)) ([5ec8208](https://github.com/starknet-io/types-js/commit/5ec8208f9e495f34472834e01458f4d3f97049d7))
32 changes: 18 additions & 14 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -17,29 +17,33 @@ npm i @starknet-io/types-js
## Types

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

```ts
// 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](https://github.com/starkware-libs/starknet-specs/tree/48e77bf4aaf687388b40b8198e3105401941517a/wallet-api)
```ts
// type import
import type { SomeWalletApiType } from '@starknet-io/types-js'
// or entire namespace import
import { WALLET_API } from '@starknet-io/types-js'

```ts
// 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)

- /src/wallet-api/typedData.ts

## Versioning (pending SPEC PR merge)
## Versioning

Starknet types-js v0.7 == Starknet Spec v0.7
Starknet types-js v0.8 == Starknet Spec v0.8

(MAJOR.MINOR) Version of this package should follow [starknet-spec](https://github.com/starkware-libs/starknet-specs) semantic versioning.
PATCH version can diverge based on bug-fixes
ex. Starknet types v0.7.x <-> Starknet Spec v0.7.x
(MAJOR.MINOR) Version of this package follow [starknet-spec](https://github.com/starkware-libs/starknet-specs) semantic versioning. PATCH version can diverge based on bug-fixes

## Devs Build

Expand Down
8 changes: 4 additions & 4 deletions package-lock.json

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

3 changes: 1 addition & 2 deletions package.json
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
{
"name": "@starknet-io/types-js",
"version": "0.7.7",
"version": "0.8.0-beta.4",
"description": "Shared TypeScript definitions for Starknet projects",
"homepage": "https://github.com/starknet-io/types-js",
"keywords": [
Expand All @@ -13,7 +13,6 @@
"dapp"
],
"license": "MIT",
"type": "module",
"exports": {
".": {
"types": "./dist/types/index.d.ts",
Expand Down
Loading