starknet-id/starknetid.js

A typescript SDK to retrieve all the on-chain data that you need from Starknet ID

Starknetid.js

Starknetid.js is a JavaScript library that facilitates interaction with the Starknet.id protocol. Whether you're a dApp developer or a blockchain enthusiast, this library provides utility functions to seamlessly integrate Starknet.id into your projects.

🔗 Full documentation of the package

Get started

Installation

# using npm
npm install starknetid.js starknet@next

# using yarn
yarn install starknetid.js starknet@next

Development

You need Node and pnpm installed. Make sure to clone this repo and run:

pnpm install
pnpm build

To start watching for changes, run:

pnpm dev

and open http://localhost:5173/

Running tests

For running tests:

pnpm test

starknetid.js's Issues

A starknet id doesn't fit in js Number (mx 2^53-1)

add utils functions & tests

• isSubdomain
• isStarkRootDomain
• isBraavosSubdomain

Create `getStarkProfiles`

gives addresses, get profiles

URI not updated

The URI is not updated when I'm going into different dapps like Flex and Nostra. My former PFP is here, while I wanted to get my Starkurabu PFP.

Tx set PFP: 0x00be89ad352fee43cd209e10dfc5df80bd14428c171da6be96680b852c1ef52e

Add github actions

Add Github actions that will run all the tests at each PR (devnet tests and unit tests).

Add CCIP domains support to reverse resolving

feat: add isXplorerSubdomain

Add isXplorerSubdomain function in utils, so it can be used elsewhere.

Add address to data

  public abstract getUserData(
    idOrDomain: number | string,
    field: string,
  ): Promise<BN>;

Get user data also with the address because the address is the only thing an app has at the beginning. It's difficult to say oh I want the discord but I have to check if my user has a starknet ID/domain, get the tokenId/domain, and then use this function.

A function with the possibility to also give an address will be easier for devs.

Remove difference between mainnet and testnet

Remove differences from testnet and mainnet to not have debt

Update to Cairo 2 contract

Support new function names and logic.

Create starknetid.js profile hooks

Description

Our goal is that features outside of the name (PFP ...) to be more used. To do that we want to enhance the dev experience when integrating starknet id and abstract everything for him to retrieve this data.

Priority number one on this would be starknet-react because this is the most used hook by the community. Ideally, we don't add any breaking change but we add the possibility for people to use retrieve PFPs and other data as easily as they can retrieve names right now.

Add a try catch in multicalls of starknetid.js

The try catch will actually be part of the multicalls but this might require updates to starknetid.js, we will create it

Make it work in prod

Atm the package does not work in production.

We have to make it work 🔥 and then use it on app.starknet.id (starknet-id/app.starknet.id#162)

Find a way to tell users their domain expired on other frontends

Ideas:

• do not disable the domain at all?
• display the domain in red?
• provide an expired field in starknet profile