Skip to content

Commit

Permalink
feat: specification implementation
Browse files Browse the repository at this point in the history
* chore: wip, revision typed Data

* fix: resolved spec

* chore: format and exports
  • Loading branch information
tabaktoni committed Apr 19, 2024
1 parent 16fcd0c commit 4aab970
Show file tree
Hide file tree
Showing 19 changed files with 940 additions and 234 deletions.
20 changes: 10 additions & 10 deletions .github/workflows/publish.yml
Original file line number Diff line number Diff line change
Expand Up @@ -15,7 +15,7 @@ on:
type: boolean
default: true
push:
branches: [ "main" ]
branches: ['main']
pull_request:
branches: '*'

Expand All @@ -25,15 +25,15 @@ jobs:
name: Quality test
runs-on: ubuntu-latest
steps:
- uses: actions/checkout@v4
- name: Run tests on Node lts/*
uses: actions/setup-node@v4
with:
node-version: lts/*
cache: 'npm'
- run: npm ci
- run: npm run pretest
- uses: actions/checkout@v4
- name: Run tests on Node lts/*
uses: actions/setup-node@v4
with:
node-version: lts/*
cache: 'npm'
- run: npm ci
- run: npm run pretest

publish:
runs-on: ubuntu-latest
if: ${{ github.ref == 'refs/heads/main' }}
Expand Down
19 changes: 14 additions & 5 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,21 +1,30 @@


# starknet-types

🐺 Starknet TypeScript types 🚀

[![GitHub Workflow Status](https://github.com/starknet-io/types-js/actions/workflows/test.yml/badge.svg)](https://github.com/starknet-io/types-js/actions/workflows/test.yml)
[![GitHub Workflow Status](https://github.com/starknet-io/types-js/actions/workflows/publish.yml/badge.svg)](https://github.com/starknet-io/types-js/actions/workflows/publish.yml)
[![Project license](https://img.shields.io/github/license/starknet-io/types-js.svg?style=flat-square)](LICENSE)
[![Pull Requests welcome](https://img.shields.io/badge/PRs-welcome-ff69b4.svg?style=flat-square)](https://github.com/starknet-io/types-js/issues?q=is%3Aissue+is%3Aopen+label%3A%22help+wanted%22)

Shared TypeScript type definitions for Starknet projects

## Types
- common enums
- Wallet JSON RPC Specification

- (WIP) api [Starknet JSON RPC Specification](https://github.com/starkware-libs/starknet-specs/tree/master/api)
- wallet-api [Wallet JSON RPC Specification](https://github.com/starkware-libs/starknet-specs/tree/48e77bf4aaf687388b40b8198e3105401941517a/wallet-api)
- SNIP-12 [Hashing and signing typed structured data](https://github.com/starknet-io/SNIPs/blob/main/SNIPS/snip-12.md)

## Versioning (wip - pending PR merge will be the first version in sync)

(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

Starknet types v0.7.x <-> Starknet Spec v0.7.x

## Usage

As a package

```bash
npm i starknet-types
```
Expand Down
2 changes: 1 addition & 1 deletion package.json
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
{
"name": "starknet-types",
"version": "0.0.5",
"version": "0.7.1",
"description": "Shared TypeScript definitions for Starknet projects",
"homepage": "https://github.com/starknet-io/types-js",
"keywords": [
Expand Down
Loading

0 comments on commit 4aab970

Please sign in to comment.