Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
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
5 changes: 3 additions & 2 deletions package.json
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
{
"name": "@wharfkit/wallet-plugin-web-authenticator",
"description": "A Web Authenticator wallet plugin for use with @wharfkit/session.",
"version": "0.3.1",
"version": "0.5.1",
"homepage": "https://github.com/wharfkit/wallet-plugin-web-authenticator",
"license": "BSD-3-Clause",
"main": "lib/wallet-plugin-web-authenticator.js",
Expand Down Expand Up @@ -63,5 +63,6 @@
"typedoc": "^0.23.14",
"typescript": "^4.1.2",
"yarn-deduplicate": "^6.0.1"
}
},
"packageManager": "yarn@1.22.22+sha512.a6b2f7906b721bba3d67d4aff083df04dad64c399707841b7acf00f6b133b7ac24255f2652fa22ae3534329dc6180534e98d17432037ff6fd140556e2bb3137e"
}
76 changes: 39 additions & 37 deletions src/index.ts
Original file line number Diff line number Diff line change
Expand Up @@ -29,22 +29,22 @@ import WebSocket from 'isomorphic-ws'
import defaultTranslations from './translations'

interface WebAuthenticatorOptions {
/** The URL of the web authenticator service */
webAuthenticatorUrl?: string
/** The URLs for the web authenticator service, keyed by chain ID */
urls: Record<string, string>
/** The buoy service URL for messaging */
buoyServiceUrl?: string
/** The buoy WebSocket for messaging */
buoyWs?: WebSocket
}

export class WalletPluginWebAuthenticator extends AbstractWalletPlugin implements WalletPlugin {
private webAuthenticatorUrl: string
private urls: Record<string, string>
private buoyServiceUrl: string
private buoyWs?: WebSocket

constructor(options: WebAuthenticatorOptions = {}) {
constructor(options: WebAuthenticatorOptions) {
super()
this.webAuthenticatorUrl = options.webAuthenticatorUrl || 'http://localhost:5174'
this.urls = options.urls
this.buoyServiceUrl = options.buoyServiceUrl || 'https://cb.anchor.link'
this.buoyWs = options?.buoyWs
}
Expand Down Expand Up @@ -85,6 +85,24 @@ export class WalletPluginWebAuthenticator extends AbstractWalletPlugin implement
*/
translations = defaultTranslations

getChainUrl(context: LoginContext | TransactContext): string {
// default to first
let url = this.urls[0]

// override if chain specified
if (context.chain) {
url = this.urls[String(context.chain.id)]
}

if (!url) {
throw new Error(
`No web authenticator URL configured for chain ID: ${context.chain?.id}`
)
}

return url
}

/**
* Opens a popup window with the given URL and waits for it to complete
*/
Expand All @@ -99,10 +117,15 @@ export class WalletPluginWebAuthenticator extends AbstractWalletPlugin implement
// Show status message using WharfKit UI
ui?.status('Opening wallet window...')

const popupWidth = 450
const popupHeight = 750
const left = Math.round(window.screenX + (window.outerWidth - popupWidth) / 2)
const top = Math.round(window.screenY + (window.outerHeight - popupHeight) / 2)

const popup: Window | null = window.open(
url,
'Web Authenticator',
'width=450,height=750'
`width=${popupWidth},height=${popupHeight},left=${left},top=${top}`
)

if (!popup) {
Expand All @@ -122,29 +145,6 @@ export class WalletPluginWebAuthenticator extends AbstractWalletPlugin implement
elements: [],
})

const checkClosed = setInterval(() => {
Copy link
Contributor

Choose a reason for hiding this comment

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

😅

if (popup?.closed) {
clearInterval(checkClosed)
ui?.status('Transaction cancelled')
reject(new Error('Transaction cancelled by user'))
}
}, 1000)

waitForCallback(receiveOptions, this.buoyWs, t)
.then((response) => {
resolve({payload: response})
})
.catch((error) => {
reject(error)
})

// Update status
ui?.prompt({
title: 'Approve',
body: 'Please approve the transaction in the wallet window.',
elements: [],
})

const checkClosedInterval = setInterval(() => {
if (popup?.closed) {
clearInterval(checkClosedInterval)
Expand Down Expand Up @@ -218,7 +218,8 @@ export class WalletPluginWebAuthenticator extends AbstractWalletPlugin implement
privateKey,
} = await createIdentityRequest(context, this.buoyServiceUrl)

const loginUrl = `${this.webAuthenticatorUrl}/sign?esr=${request.encode()}&chain=${
const url = this.getChainUrl(context)
const loginUrl = `${url}/sign?esr=${request.encode()}&chain=${
context.chain?.id
}&requestKey=${requestKey}`

Expand All @@ -228,8 +229,8 @@ export class WalletPluginWebAuthenticator extends AbstractWalletPlugin implement
context.ui
)

this.data.privateKey = String(privateKey)
this.data.publicKey = payload.link_key
this.data.encryptionKey = String(privateKey)
this.data.messageKey = payload.link_key

if (!payload.cid) {
throw new Error('Login failed: No chain ID returned')
Expand Down Expand Up @@ -274,7 +275,7 @@ export class WalletPluginWebAuthenticator extends AbstractWalletPlugin implement
): Promise<WalletPluginSignResponse> {
try {
// Ensure we have a request key from login
if (!this.data.privateKey || !this.data.publicKey) {
if (!this.data.encryptionKey || !this.data.messageKey) {
throw new Error('No request keys available - please login first')
}

Expand All @@ -299,18 +300,19 @@ export class WalletPluginWebAuthenticator extends AbstractWalletPlugin implement

const sealedRequest = await sealMessage(
modifiedRequest.encode(),
PrivateKey.from(this.data.privateKey),
PublicKey.from(this.data.publicKey),
PrivateKey.from(this.data.encryptionKey),
PublicKey.from(this.data.messageKey),
nonce
)

const signUrl = `${this.webAuthenticatorUrl}/sign?sealed=${sealedRequest.toString(
const url = this.getChainUrl(context)
const signUrl = `${url}/sign?sealed=${sealedRequest.toString(
'hex'
)}&nonce=${nonce.toString()}&chain=${context.chain?.id}&accountName=${
context.accountName
}&permissionName=${context.permissionName}&appName=${
context.appName
}&requestKey=${String(PrivateKey.from(this.data.privateKey).toPublic())}`
}&requestKey=${String(PrivateKey.from(this.data.encryptionKey).toPublic())}`

const response = await this.openPopup(signUrl, callback, context.ui)

Expand Down
39 changes: 24 additions & 15 deletions test/tests/common.ts
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
import {Chains, SessionKit} from '@wharfkit/session'
import {PermissionLevel, Signature, APIClient, PrivateKey} from '@wharfkit/antelope'
import {APIClient, PermissionLevel, PrivateKey, Signature} from '@wharfkit/antelope'
import {
mockChainDefinition,
mockPermissionLevel,
Expand All @@ -9,21 +9,21 @@ import {
} from '@wharfkit/mock-data'
import {assert} from 'chai'
import {
LoginContext,
ResolvedSigningRequest,
TransactContext,
ChainDefinition,
ABICacheInterface,
WalletPluginSignResponse,
UserInterface,
Cancelable,
ChainDefinition,
CreateAccountContext,
LoginContext,
LoginHooks,
PromptArgs,
PromptResponse,
ResolvedSigningRequest,
TransactContext,
TransactHooks,
LoginHooks,
UserInterfaceLoginResponse,
UserInterface,
UserInterfaceAccountCreationResponse,
CreateAccountContext,
UserInterfaceLoginResponse,
WalletPluginSignResponse,
} from '@wharfkit/session'

import {WalletPluginWebAuthenticator} from '$lib'
Expand Down Expand Up @@ -184,7 +184,10 @@ suite('wallet plugin', function () {

test('login functionality', async function () {
const plugin = new WalletPluginWebAuthenticator({
webAuthenticatorUrl: 'https://web-authenticator.greymass.com',
urls: {
'73e4385a2708e6d7048834fbc1079f2fabb17b3c125b146af438971e90716c4d':
'https://web-authenticator.greymass.com',
},
})

// Mock login context
Expand Down Expand Up @@ -229,14 +232,17 @@ suite('wallet plugin', function () {

test('sign functionality', async function () {
const plugin = new WalletPluginWebAuthenticator({
webAuthenticatorUrl: 'https://web-authenticator.greymass.com',
urls: {
'73e4385a2708e6d7048834fbc1079f2fabb17b3c125b146af438971e90716c4d':
'https://web-authenticator.greymass.com',
},
})

// Use different keys for the sign test to avoid channel ID conflicts
const signPrivateKey = PrivateKey.generate('K1')
const signPublicKey = signPrivateKey.toPublic()
plugin.data.privateKey = signPrivateKey
plugin.data.publicKey = signPublicKey
plugin.data.encryptionKey = signPrivateKey
plugin.data.messageKey = signPublicKey

const mockResolvedSigningRequest = await makeMockResolvedSigningRequest()

Expand Down Expand Up @@ -275,7 +281,10 @@ suite('wallet plugin', function () {

test('popup success with UI feedback', async function () {
const plugin = new WalletPluginWebAuthenticator({
webAuthenticatorUrl: 'https://web-authenticator.greymass.com',
urls: {
'73e4385a2708e6d7048834fbc1079f2fabb17b3c125b146af438971e90716c4d':
'https://web-authenticator.greymass.com',
},
})

// Mock login context with UI
Expand Down