npm package: @splitwave/sol-wallet-names
Description: Resolves Solana wallet names (.abc, .backpack, .bonk, .glow, .sol, and .poor) to wallet addresses and back.
Author: SplitWave, Timadigwe, JunaidPeer
Latest version: 1.0.0

# Solana Wallet Names

Updated from portal payements 

[![Build status](https://github.com/Splitwave/solana-wallet-names/actions/workflows/tests.yaml/badge.svg)](https://github.com/Splitwave/solana-wallet-names/actions)

This package resolves **wallet names** (like `mikemaccana.sol`) to **wallet addresses** (like `5FHwkrdxntdK24hgQU8qgBjn35Y1zwhz1GZwCkP2UJnM`) across **the entire Solana ecosystem**, including **✨8✨ different name services** and **✨5✨ different profile picture (PFP) services**. Reverse mapping (wallet addresses to names) is also supported in most cases.

| Name      | Name to Address | Address to Name | PFP source          |
| --------- | :-------------: | --------------: | ------------------- |
| .abc      |       ✅        |              ✅ | Solana PFP Standard |
| .backpack |       ❌        |              ❌ | Backpack            |
| .bonk     |       ✅        |              ✅ | Solana PFP Standard |
| .glow     |       ✅        |              ✅ | Glow ID             |
| .poor     |       ✅        |              ✅ | Solana PFP Standard |
| .sol      |       ✅        |              ✅ | Solana PFP Standard |
| .ottr     |       🔜        |              🔜 | 🔜                  |

Note to wallets that don't include address-to-name mappings (currently just Backpack): [not implementing address to name mappings does not help user privacy](https://twitter.com/mikemaccana/status/1674758907657441280). All it does it means your users see an ugly set of characters when they log into a dApp rather than their wallet name.

We've had experimental support for `.ottr` too, it will be coming back in future soon.

We previously supported `@twitter` using Bonfida's API, however in practice very few Solana users have bothered mapping their Twitter accounts to their wallets so we ended up removing this support. If you have any thoughts about this please let us know!

## Note: wallet names do not assert identity

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 of this:

> **Warning**
> There is no guarantee that (walletName) represents a particular individual or organisation.

We'll 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

```
npm i "@portal-payments/solana-wallet-names"
```

# Setup

All you need is a Solana `Connection` object. Optionally, you can also get a [Twitter bearer token](https://developer.twitter.com/en/docs/authentication/oauth-2-0/bearer-tokens) - not including `twitterBearerToken` will simply disable Twitter results.

## 🧑🏻‍🦱➡️🔡🖼️ Wallet name to wallet address (and profile picture)

If you have a wallet name, like `mikemaccana.abc`, and you want to get an address and profile picture:

```typescript
import { walletNameToAddressAndProfilePicture } from '@portal-payments/solana-wallet-names';

const walletAddressAndProfilePicture =
  await walletNameToAddressAndProfilePicture(
    // A Solana connection
    connection,
    // One of: .abc .backpack .bonk .glow .poor .sol or @twitter
    'mikemaccana.abc'
  );
```

`walletAddressAndProfilePicture` will look like:

```
{
  walletAddress: "5FHwkrdxntdK24hgQU8qgBjn35Y1zwhz1GZwCkP2UJnM",
  profilePicture: https://some.url/filename.ext,
}
```

If either (or both) aren't found, they will be `null`. We only error for actual errors (and don't throw error when there are no results):

```
{
  walletAddress: null,
  profilePicture: null,
}
```

## 🔡➡️🧑🏻‍🦱🖼️ Wallet address to wallet name (and profile picture)

If you have a wallet address, like `5FHwkrdxntdK24hgQU8qgBjn35Y1zwhz1GZwCkP2UJnM`, and you want to get an address and profile picture:

```typescript
import { walletAddressToNameAndProfilePicture } from '@portal-payments/solana-wallet-names';

const walletNameAndProfilePicture = await walletAddressToNameAndProfilePicture(
  // A Solana connection
  connection,
  // A Solana wallet address
  walletAddress
);
```

`walletNameAndProfilePicture` will look like:

```
{
  walletName: "mikemaccana.sol",
  profilePicture: https://some.url/filename.ext,
}
```

## 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.
- Solana PFP Standard uses the Netscape 'broken image' icon for missing images. This is ugly, so instead we return `null`.
- Ottr is only on the backend for now
- Backpack and Ottr do not currently have wallet address to name mappings available.

# Contributing

This library is designed to support all Solana naming services - as new services are added over time, we'd love you to contribute them here.

<!-- Please see [Portal Wallet Coding Guidelines](https://github.com/portalpayments/portalwallet/blob/main/CODING_GUIDELINES.md) when writing your PRs. -->

File issues in the **Issues** tab in GitHub

# Changelog

See [CHANGELOG](./CHANGELOG.md).