Skip to content
This repository has been archived by the owner on May 22, 2024. It is now read-only.

starknet-id/old_identity

Repository files navigation

Starknet.id Contract

This contract is written in Cairo. It allows to mint identity nfts. The nft contains fields associated to values. To each field, value can be bound, certified by a user or other contracts. For the same field there can be multiple values from multiple contracts.

Official addresses of deployment:

  • Goerli: 0x783a9097b26eae0586373b2ce0ed3529ddc44069d1e0fbc4f66d42b69d6850d
  • Mainnet: 0x05dbdedc203e92749e2e746e2d40a768d966bd243df04a6b712e222bc040a9af

Usage

Note: When rewriting extended data, you might want to add a zero at the end to tell to unbounded read where to stop.

For users

// mint a nft with id token_id (can be random, must not be already minted)
mint(token_id);

// write a data (my discord id) associated to a token_id of a NFT I own and a type (here the felt 'discord')
set_user_data(token_id, 'discord', 707979046952239197);

// write multiple felts
set_extended_user_data(token_id, 'avatar', 3, new('my', 'avatar', 'url'));

For verifiers

// confirm this data is correct for this specific type and token_id (e.g. you got a proof)
set_verifier_data(token_id, 'discord', 707979046952239197);

// same with multiple felts
set_extended_verifier_data(token_id, 'avatar', 3, new('my', 'avatar', 'url'));

For external services

// get data written by the nft owner
get_user_data(token_id, 'discord');

// retrieving an array knowing its size (will return zeros if not written)
get_extended_user_data(token_id, 'avatar', 3);

// retrieving an array up to zero (not included)
get_unbounded_user_data(token_id, 'avatar');

// get data written by the specified verifier
get_verifier_data(token_id, 'discord', verifier_addr);
get_extended_verifier_data(token_id, 'avatar', 3, verifier_addr);
get_unbounded_verifier_data(token_id, 'avatar', verifier_addr);

Building/testing

Setup: protostar install Testing: protostar test Building: protostar build Deploying: python deploy.py <private_key>