Solana AuthMethod and Verifier

Implements support to authenticate, authorize and verify with Solana accounts as a did:pkh with SIWS(X) and CACAO. Primarly used with did-session and @didtools/cacao.

Installation

npm install --save @didtools/pkh-solana

Auth Usage

To Auth in web based env, use any injected Solana provider that implements the standard wallet/provider interface with SolanaWebAuth.

// Web Auth Usage
import { SolanaWebAuth, getAccountIdByNetwork } from '@didtools/pkh-solana'
// ...

const solProvider = // import/get your Solana provider (ie: window.phantom.solana)
const address = await solProvider.connect()
const accountId = getAccountIdByNetwork('mainnet', address.publicKey.toString())

const authMethod = await SolanaWebAuth.getAuthMethod(solProvider, accountId)

To Auth in a Node based env, use any standard Solana provider interface with SolanaNodeAuth

// Node Auth Usage
import { SolanaNodeAuth, getAccountIdByNetwork } from '@didtools/pkh-solana'
// ...

const solProvider = // import/get your Solana provider (ie: window.phantom.solana)
const address = await solProvider.connect()
const accountId = getAccountIdByNetwork('mainnet', address.publicKey.toString())
const appName = 'MyNodeApp'

const authMethod = await SolanaWebAuth.getAuthMethod(solProvider, accountId, appName)

To use with did-session and reference did-session docs for more details.

const client = new ComposeClient({ceramic, definition})
const resources = client.resources

const session = await DIDSession.authorize(authMethod, { resources })
client.setDID(session.did)

Configuration

AuthMethod creators consume a standard Solana provider and an AccountId. AccountID follows the CAIP10 standard. The helper methods getAccountIdByNetwork and getAccountId are provided, but you can also create an AccountID using the CAIP library directly.

import { AccountId } from 'caip'
import { getAccountIdByNetwork, getAccountId } from '@didtools/pkh-solana'
import { Connection, clusterApiUrl } from "@solana/web3.js"

// Using network string
const accountId = getAccountIdByNetwork('mainnet', address)

// With CAIP
const ethMainnetChainId = '1'
const chainNameSpace = 'eip155'
const chainId = `${chainNameSpace}:${ethMainnetChainId}`
const accountIdCAIP = new AccountId({ address, chainId })

// Using Solana Connection to query connect network/chain
const connection = new Connection(solanaWeb3.clusterApiUrl("mainnet-beta"))
const accountIdByConnection = await getAccountIdSolana(connection, address)

// accountId = accountIdCAIP = accountIdByConnection

The SolanaNodeAuth additionally consumes an application name. The 'SolanaWebAuth' method uses your application domain name by default.

import { SolanaNodeAuth } from '@didtools/pkh-solana'

const appName = 'MyNodeApp'
const authMethod = SolanaNodeAuth.getAuthMethod(solProvider, accountId, appName)

Verifier Usage

Verifiers are needed to verify different did:pkh signed payloads using CACAO. Libraries that need them will consume a verifiers map allowing your to register the verifiers you want to support.

import { Cacao } from '@didtools/cacao'
import { getSolanaVerifier } from '@didtools/pkh-solana'
import { DID } from 'dids'

const verifiers = {
    ...getSolanaVerifier()
}

// Directly with cacao
Cacao.verify(cacao, { verifiers, ...opts})

// With DIDS, reference DIDS for more details
const dids = //configured dids instance
await dids.verifyJWS(jws, { capability, verifiers, ...opts})

Namespaces

• SolanaNodeAuth
• SolanaWebAuth

Type Aliases

SupportedConnection

Ƭ SupportedConnection: Object

Type declaration

Name	Type
getGenesisHash	() => Promise<string>

---

SupportedProvider

Ƭ SupportedProvider: Object

Type declaration

Name	Type
signMessage	(message: Uint8Array, type: string) => Promise<{ signature: Uint8Array }>

Variables

CHAIN_NAMESPACE

• Const CHAIN_NAMESPACE: "solana"

---

SOLANA_DEVNET_CHAIN_REF

• Const SOLANA_DEVNET_CHAIN_REF: "EtWTRABZaYq6iMfeYKouRu166VU2xqa1"

---

SOLANA_MAINNET_CHAIN_REF

• Const SOLANA_MAINNET_CHAIN_REF: "5eykt4UsFv8P8NJdTREpY1vzqKqZKvdp"

---

SOLANA_TESTNET_CHAIN_REF

• Const SOLANA_TESTNET_CHAIN_REF: "4uhcVJyU9pJkvQyS88uRDiswHXSCkY3z"

---

VERSION

• Const VERSION: "1"

---

chainIdMap

• Const chainIdMap: Object

Type declaration

Name	Type
devnet	string
mainnet	string
testnet	string

Functions

assertSupportedConnection

▸ assertSupportedConnection(solConnection): asserts solConnection is SupportedConnection

Parameters

Name	Type
solConnection	any

Returns

asserts solConnection is SupportedConnection

---

assertSupportedProvider

▸ assertSupportedProvider(solProvider): asserts solProvider is SupportedProvider

Parameters

Name	Type
solProvider	any

Returns

asserts solProvider is SupportedProvider

---

getAccountId

▸ getAccountId(solConnection, address): Promise<AccountId>

Helper function to get an accountId (CAIP10) for an Solana account by Solana Connection interface, Connection must implement 'getGenesisHash()'

Parameters

Name	Type
solConnection	any
address	string

Returns

Promise<AccountId>

---

getAccountIdByNetwork

▸ getAccountIdByNetwork(network, address): AccountId

Helper function to get an accountId (CAIP10) for an Solana account by network string 'mainet' | 'testnet' | 'devenet'

Parameters

Name	Type
network	SolanaNetwork
address	string

Returns

AccountId

---

getSolanaVerifier

▸ getSolanaVerifier(): Verifiers

Get a configured CACAO SolanaVerifier map for Solana accounts

Returns

Verifiers

---

requestChainId

▸ requestChainId(solConnection): Promise<string>

Parameters

Name	Type
solConnection	any

Returns

Promise<string>

---

verifySolanaSignature

▸ verifySolanaSignature(cacao, options): void

Parameters

Name	Type
cacao	Cacao
options	VerifyOptions

Returns

void