Skip to content

Commit

Permalink
Minor doc tweaks
Browse files Browse the repository at this point in the history
  • Loading branch information
mikemaccana committed Apr 27, 2023
1 parent 44339f9 commit cd9ccce
Showing 1 changed file with 7 additions and 3 deletions.
10 changes: 7 additions & 3 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -20,17 +20,17 @@ Supported **wallet names** are:

## Note: wallet names do not assert identity

Wallet names are a convenient alternative for wallet addresses. However **wallet names do not assert identity**. The services used in this library do not check the real-world identity of people registering wallet names.
Wallet names are a convenient alternative for wallet addresses. However **wallet names do not assert real world identity**. Most of services used in this library do not check the real-world identity of people registering wallet names.
- Many wallet names that sounds like real world people and organisations are not those organisation - `barclays.sol` isn't Barclays, `cashapp.sol` isn't cashapp, `joemccann.sol` isn't the well known Solana investor. This isn't just Solana, all blockchain name services and DNS itself operate this way. Having a particular name registered simply means the holder was the first person to register that name.
- Wallet name services that include given and family names do not check that the person has identification matching the given and family names.
- Profile picture services do not check that the person depicted matches the owner of the wallet

Ensure users are aware that wallet names do not assert identity:
Ensure users are aware of this:

> **Warning**
> There is no guarantee that (walletName) represents a particular individual or organisation.
Use the [Solana Verification]() (coming 🔜) library to assert individual or organisation identity and/or get profile pictures that are proven match the identity of the wallet holder.
Well be releasing some other tech 🔜 to assert individual or organisation identity and get profile pictures that are proven match the identity of the wallet holder.

# Installation

Expand Down Expand Up @@ -99,6 +99,10 @@ const walletNameAndProfilePicture = await walletAddressToNameAndProfilePicture(
}
```

## Was this useful?

I'm a poor startup founder. Send me some tokens! `mikemaccana.sol`.

## Limits

- In cases where addresses can have multiple account names, only the first or 'main' account name is returned.
Expand Down

0 comments on commit cd9ccce

Please sign in to comment.