Skip to content

Updated Wallet Provider API Methods page #6

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
HakPoghosyan wants to merge 3 commits into
base: main
Choose a base branch
from
Open

Updated Wallet Provider API Methods page #6

Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
3712c81
Updated Wallet Provider API Methods page
HakPoghosyan Jan 16, 2026
66f5357
Added POPUP_ERROR to xmTransaction error list
HakPoghosyan Jan 16, 2026
af08d3f
Added Nomis Score section
HakPoghosyan Jan 20, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
182 changes: 175 additions & 7 deletions frontend/demos-wallet-provider-api/wallet-provider-api-methods.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -41,7 +41,7 @@ These let your dApp construct transactions (or messages) and have the wallet sig
* **Params**: `[ message: string ]`
* **Behavior**: opens a sign popup for a plain message.
* **Success data**: `{ signature: string }` (wrapped by the wallet; underlying object includes `{ success: true, signature }`)
* **Errors**: `signError`, `signCancelled`, `TIMEOUT`, `NOT_LOGGED_IN`
* **Errors**: `signError`, `signCancelled`, `TIMEOUT`

Example:

Expand All @@ -54,7 +54,7 @@ const res = await provider.request({ method: 'sign', params: ['hello world'] });
* **Params**: `[ unsignedTransaction: Transaction ]`
* **Behavior**: opens a sign-transaction popup and returns the signed transaction.
* **Success data**: `{ signedTransaction }` (wrapped; underlying object includes `{ success: true, signedTransaction }`)
* **Errors**: `signTransactionError`, `signTransactionCancelled`, `TIMEOUT`, `NOT_LOGGED_IN`
* **Errors**: `signTransactionError`, `signTransactionCancelled`, `TIMEOUT`

Example:

Expand Down Expand Up @@ -111,12 +111,28 @@ const res = await provider.request({
});
```

### Identity
#### xmTransaction

* **Params**: `[ payload: XMScript ]`
* **Behavior**: creates an XM (cross-chain) transaction payload, validates it, and opens validation popup for user confirmation and broadcast.
* **Success data**: `{ result, validityData }`
* **Errors**: `xmTransactionError`, `validationCancelled`, `TIMEOUT`, `POPUP_ERROR`

Example:

```ts
const payload = {/* XMScript from SDK */};
const res = await provider.request({ method: 'xmTransaction', params: [payload] });
```

## Identity

### Cross-Chain (XM) Identities

#### getXmIdentities

* **Params**: none
* **Success data**: list of identities from SDK
* **Success data**: list of XM identities from SDK
* **Errors**: `getXmIdentitiesError`

Example:
Expand Down Expand Up @@ -153,6 +169,8 @@ const payload = { /* XMCoreTargetIdentityPayload */ };
const res = await provider.request({ method: 'removeXmIdentity', params: [payload] });
```

### Web2 Identities

#### getWeb2Identities

* **Params**: none
Expand All @@ -169,7 +187,7 @@ const res = await provider.request({ method: 'getWeb2Identities' });

* **Params**: none
* **Success data**: proof payload to be used for Web2 identity linking
* **Errors**: `getWeb2IdentityProofPayloadError` (also returned if user not logged in)
* **Errors**: `getWeb2IdentityProofPayloadError`

Example:

Expand All @@ -179,8 +197,8 @@ const res = await provider.request({ method: 'getWeb2IdentityProofPayload' });

#### addTwitterIdentity

* **Params**: `[payload: TwitterProof]`
* **Behavior**: validates and prompts user in validation popup; upon confirmation broadcasts.
* **Params**: `[payload: TwitterProof, referralCode?: string]`
* **Behavior**: validates and prompts user in validation popup; upon confirmation broadcasts. Optional referral code can be provided as second parameter.
* **Success data**: `{ result, validityData }`
* **Errors**: `addTwitterIdentityError`, `addTwitterIdentityCancelled`, `TIMEOUT`

Expand All @@ -189,6 +207,37 @@ Example:
```ts
const proof = /* TwitterProof from your backend/SDK */
const res = await provider.request({ method: 'addTwitterIdentity', params: [proof] });

// With referral code
const res = await provider.request({ method: 'addTwitterIdentity', params: [proof, 'REFERRAL123'] });
```

#### addDiscordIdentity

* **Params**: `[payload: DiscordProof]`
* **Behavior**: validates Discord identity proof and prompts user in validation popup; upon confirmation broadcasts.
* **Success data**: `{ result, validityData }`
* **Errors**: `addDiscordIdentityError`, `addDiscordIdentityCancelled`, `TIMEOUT`

Example:

```ts
const proof = /* DiscordProof from your backend/SDK */
const res = await provider.request({ method: 'addDiscordIdentity', params: [proof] });
```

#### addGithubIdentity

* **Params**: `[payload: GithubProof]`
* **Behavior**: validates Github identity proof and prompts user in validation popup; upon confirmation broadcasts.
* **Success data**: `{ result, validityData }`
* **Errors**: `addGithubIdentityError`, `addGithubIdentityCancelled`, `TIMEOUT`

Example:

```ts
const proof = /* GithubProof from your backend/SDK */
const res = await provider.request({ method: 'addGithubIdentity', params: [proof] });
```

#### removeWeb2Identity
Expand All @@ -206,3 +255,122 @@ const res = await provider.request({
params: [{ context: 'twitter', username: 'handle' }],
});
```

### Unstoppable Domains

#### getUDChallenge

* **Params**: `[ demosPublicKey: string, signingAddress: string ]`
* **Behavior**: generates a challenge string for Unstoppable Domains identity verification.
* **Success data**: challenge string
* **Errors**: `getUDChallengeError`

Example:

```ts
const res = await provider.request({
method: 'getUDChallenge',
params: ['demosPublicKey123', '0xabc...'],
});
```

#### getUDResolution

* **Params**: `[ domain: string ]`
* **Behavior**: resolves an Unstoppable Domain to get its resolution data.
* **Success data**: `UnifiedDomainResolution` object
* **Errors**: `getUDResolutionError`

Example:

```ts
const res = await provider.request({
method: 'getUDResolution',
params: ['mydomain.crypto'],
});
```

#### addUDIdentity

* **Params**: `[ signingAddress: string, signature: string, challenge: string, resolutionData: UnifiedDomainResolution, referralCode?: string ]`
* **Behavior**: validates Unstoppable Domain identity with the provided signature and challenge, prompts user in validation popup; upon confirmation broadcasts. Optional referral code can be provided.
* **Success data**: `{ result, validityData }`
* **Errors**: `addUDIdentityError`, `addUDIdentityCancelled`, `TIMEOUT`

<Note>
The `signingAddress` should be an EVM address (e.g., `0x...`) or Solana address based on the chosen chain. Similarly, the `signature` should be an EVM signature or Solana signature corresponding to the chain used for signing.
</Note>

Example:

```ts
// First get the challenge
const challengeRes = await provider.request({
method: 'getUDChallenge',
params: [demosPublicKey, signingAddress],
});

// Get resolution data
const resolutionRes = await provider.request({
method: 'getUDResolution',
params: ['mydomain.crypto'],
});

// Sign the challenge with user's wallet (EVM or Solana), then add identity
const res = await provider.request({
method: 'addUDIdentity',
params: [signingAddress, signature, challengeRes.data, resolutionRes.data],
});

// With referral code
const res = await provider.request({
method: 'addUDIdentity',
params: [signingAddress, signature, challengeRes.data, resolutionRes.data, 'REFERRAL123'],
});
```
Comment on lines +306 to +330

@coderabbitai coderabbitai Bot Jan 20, 2026

Copy link
Copy Markdown

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

⚠️ Potential issue | 🟡 Minor

Fix duplicate variable declaration in code example.

The example declares const res twice (lines 320 and 326) within the same code block, which would cause a syntax error in JavaScript/TypeScript. Use different variable names or restructure as separate examples.

📝 Suggested fix 
 // Sign the challenge with user's wallet (EVM or Solana), then add identity
 const res = await provider.request({
   method: 'addUDIdentity',
   params: [signingAddress, signature, challengeRes.data, resolutionRes.data],
 });

 // With referral code
-const res = await provider.request({
+const resWithReferral = await provider.request({
   method: 'addUDIdentity',
   params: [signingAddress, signature, challengeRes.data, resolutionRes.data, 'REFERRAL123'],
 });
🤖 Prompt for AI Agents 
In `@frontend/demos-wallet-provider-api/wallet-provider-api-methods.mdx` around
lines 306 - 330, The code sample declares `const res` twice which causes a
duplicate declaration error; update the second call to `provider.request` (the
one that includes the referral code) to use a different variable name (e.g.,
`resWithReferral` or `res2`) or reuse the same binding by removing `const` and
assigning into the prior `res`, ensuring the second `addUDIdentity` invocation
that uses signingAddress, signature, challengeRes.data, resolutionRes.data, and
the referral string is uniquely named.


### Nomis Score

#### getNomisScore

* **Params**: `[ walletAddress: string, chain: string ]`
* **Behavior**: fetches the Nomis score for the specified wallet address on the given chain.
* **Success data**: Nomis score response object
* **Errors**: `getNomisScoreError`

Example:

```ts
const res = await provider.request({
method: 'getNomisScore',
params: ['0xabc...', 'evm'], // chain: 'evm' or 'solana'
});
```

#### addNomisIdentity

* **Params**: `[ payload: NomisWalletIdentity ]`
* **Behavior**: validates Nomis identity and prompts user in validation popup; upon confirmation broadcasts.
* **Success data**: `{ result, validityData }`
* **Errors**: `addNomisIdentityError`, `addNomisIdentityCancelled`, `TIMEOUT`

Example:

```ts
const payload = {/* NomisWalletIdentity from SDK */};
const res = await provider.request({ method: 'addNomisIdentity', params: [payload] });
```

#### removeNomisIdentity

* **Params**: `[ payload: NomisWalletIdentity ]`
* **Behavior**: creates removal validity data and prompts user in validation popup; upon confirmation broadcasts.
* **Success data**: `{ result, validityData }`
* **Errors**: `removeNomisIdentityError`, `removeNomisIdentityCancelled`, `TIMEOUT`

Example:

```ts
const payload = {/* NomisWalletIdentity to remove */};
const res = await provider.request({ method: 'removeNomisIdentity', params: [payload] });
```