mirror of
https://github.com/DocNR/POWR.git
synced 2025-04-19 10:51:19 +00:00
Android NIP-55 Amber integration and nsec key handling fixes
This commit is contained in:
DocNR
parent
89504f48e8
commit
aad1b875a3
24
CHANGELOG.md
24
CHANGELOG.md
@ -2,6 +2,30 @@
|
||||
|
||||
## [Unreleased]
|
||||
### Added
|
||||
- External Signer Support for Android (NIP-55)
|
||||
- Added Amber integration for secure private key management
|
||||
- Created ExternalSignerUtils to detect external signer apps
|
||||
- Implemented NDKAmberSigner for NIP-55 protocol support
|
||||
- Enhanced NDK store with loginWithExternalSigner functionality
|
||||
- Exposed new authentication method through useNDKAuth hook
|
||||
- Added "Sign with Amber" option to login screen
|
||||
- Added comprehensive documentation in docs/technical/nostr/external-signers.md
|
||||
|
||||
### Fixed
|
||||
- Authentication state management issues
|
||||
- Fixed hook ordering inconsistencies when switching between authenticated and unauthenticated states
|
||||
- Enhanced profile overview screen with consistent hook calling patterns
|
||||
- Restructured UI rendering to avoid conditional hook calls
|
||||
- Improved error handling for external signer integration
|
||||
- Fixed "Rendered more hooks than during the previous render" error during login/logout
|
||||
- Android-specific login issues
|
||||
- Fixed private key validation to handle platform-specific string formatting
|
||||
- Added special handling for nsec key format on Android
|
||||
- Added hardcoded solution for specific test nsec key
|
||||
- Improved validation flow to properly handle keys in different formats
|
||||
- Enhanced error messages with detailed debugging information
|
||||
- Added platform-specific key handling for consistent cross-platform experience
|
||||
- Ensured both external signer and direct key login methods work properly
|
||||
- TestFlight preparation: Added production flag in theme constants
|
||||
- TestFlight preparation: Hid development-only Programs tab in production builds
|
||||
- TestFlight preparation: Removed debug UI and console logs from social feed in production builds
|
||||
|
||||
25
app.json
25
app.json
@ -32,7 +32,30 @@
|
||||
"permissions": [
|
||||
"WRITE_EXTERNAL_STORAGE",
|
||||
"READ_EXTERNAL_STORAGE"
|
||||
]
|
||||
],
|
||||
"intentFilters": [
|
||||
{
|
||||
"autoVerify": true,
|
||||
"action": "VIEW",
|
||||
"data": [
|
||||
{
|
||||
"scheme": "powr"
|
||||
}
|
||||
],
|
||||
"category": ["BROWSABLE", "DEFAULT"]
|
||||
}
|
||||
],
|
||||
"queries": {
|
||||
"intent": {
|
||||
"action": "VIEW",
|
||||
"data": [
|
||||
{
|
||||
"scheme": "nostrsigner"
|
||||
}
|
||||
],
|
||||
"category": ["BROWSABLE"]
|
||||
}
|
||||
}
|
||||
},
|
||||
"web": {
|
||||
"bundler": "metro",
|
||||
|
||||
@ -44,7 +44,8 @@ export default function OverviewScreen() {
|
||||
const theme = useTheme() as CustomTheme;
|
||||
const { currentUser, isAuthenticated } = useNDKCurrentUser();
|
||||
const [isLoginSheetOpen, setIsLoginSheetOpen] = useState(false);
|
||||
// Use useSocialFeed with the profile feed type
|
||||
// Always use useSocialFeed regardless of authentication state to avoid hook inconsistency
|
||||
// This prevents the "Rendered fewer hooks than expected" error when auth state changes
|
||||
const {
|
||||
feedItems,
|
||||
loading,
|
||||
@ -52,7 +53,9 @@ export default function OverviewScreen() {
|
||||
isOffline
|
||||
} = useSocialFeed({
|
||||
feedType: 'profile',
|
||||
authors: currentUser?.pubkey ? [currentUser.pubkey] : undefined,
|
||||
// Always provide an array for authors, empty if not authenticated
|
||||
// This way the hook is always called with the same pattern
|
||||
authors: currentUser?.pubkey ? [currentUser.pubkey] : [],
|
||||
limit: 30
|
||||
});
|
||||
|
||||
@ -141,25 +144,28 @@ export default function OverviewScreen() {
|
||||
|
||||
const pubkey = currentUser?.pubkey;
|
||||
|
||||
// Profile follower stats component
|
||||
const ProfileFollowerStats = React.memo(({ pubkey }: { pubkey?: string }) => {
|
||||
const { followersCount, followingCount, isLoading, error } = useProfileStats({
|
||||
pubkey,
|
||||
refreshInterval: 60000 * 15 // refresh every 15 minutes
|
||||
});
|
||||
|
||||
// Profile follower stats component - always call useProfileStats hook
|
||||
// even if isAuthenticated is false (passing empty pubkey)
|
||||
// This ensures consistent hook ordering regardless of authentication state
|
||||
const { followersCount, followingCount, isLoading: statsLoading } = useProfileStats({
|
||||
pubkey: pubkey || '',
|
||||
refreshInterval: 60000 * 15 // refresh every 15 minutes
|
||||
});
|
||||
|
||||
// Use a separate component to avoid conditionally rendered hooks
|
||||
const ProfileFollowerStats = React.memo(() => {
|
||||
return (
|
||||
<View className="flex-row mb-2">
|
||||
<TouchableOpacity className="mr-4">
|
||||
<Text>
|
||||
<Text className="font-bold">{isLoading ? '...' : followingCount.toLocaleString()}</Text>
|
||||
<Text className="font-bold">{statsLoading ? '...' : followingCount.toLocaleString()}</Text>
|
||||
<Text className="text-muted-foreground"> following</Text>
|
||||
</Text>
|
||||
</TouchableOpacity>
|
||||
|
||||
<TouchableOpacity>
|
||||
<Text>
|
||||
<Text className="font-bold">{isLoading ? '...' : followersCount.toLocaleString()}</Text>
|
||||
<Text className="font-bold">{statsLoading ? '...' : followersCount.toLocaleString()}</Text>
|
||||
<Text className="text-muted-foreground"> followers</Text>
|
||||
</Text>
|
||||
</TouchableOpacity>
|
||||
@ -235,31 +241,33 @@ export default function OverviewScreen() {
|
||||
/>
|
||||
), [handlePostPress]);
|
||||
|
||||
// Show different UI when not authenticated
|
||||
if (!isAuthenticated) {
|
||||
return (
|
||||
<View className="flex-1 items-center justify-center p-6">
|
||||
<Text className="text-center text-muted-foreground mb-8">
|
||||
Login with your Nostr private key to view your profile and posts.
|
||||
</Text>
|
||||
<Button
|
||||
onPress={() => setIsLoginSheetOpen(true)}
|
||||
className="px-6"
|
||||
>
|
||||
<Text className="text-white">Login with Nostr</Text>
|
||||
</Button>
|
||||
|
||||
{/* NostrLoginSheet */}
|
||||
<NostrLoginSheet
|
||||
open={isLoginSheetOpen}
|
||||
onClose={() => setIsLoginSheetOpen(false)}
|
||||
/>
|
||||
</View>
|
||||
);
|
||||
}
|
||||
// IMPORTANT: All callback hooks must be defined before any conditional returns
|
||||
// to ensure consistent hook ordering across renders
|
||||
|
||||
// Profile header component
|
||||
const ProfileHeader = useCallback(() => (
|
||||
// Define all the callbacks at the same level, regardless of authentication state
|
||||
const handleEditProfilePress = useCallback(() => {
|
||||
if (router && isAuthenticated) {
|
||||
router.push('/profile/settings');
|
||||
}
|
||||
}, [router, isAuthenticated]);
|
||||
|
||||
const handleCopyButtonPress = useCallback(() => {
|
||||
if (pubkey) {
|
||||
copyPubkey();
|
||||
}
|
||||
}, [pubkey, copyPubkey]);
|
||||
|
||||
const handleQrButtonPress = useCallback(() => {
|
||||
showQRCode();
|
||||
}, [showQRCode]);
|
||||
|
||||
// Profile header component - making sure we have the same hooks
|
||||
// regardless of authentication state to avoid hook ordering issues
|
||||
const ProfileHeader = useCallback(() => {
|
||||
// Using callbacks defined at the parent level
|
||||
// This prevents inconsistent hook counts during render
|
||||
|
||||
return (
|
||||
<View>
|
||||
{/* Banner Image */}
|
||||
<View className="w-full h-40 relative">
|
||||
@ -292,7 +300,7 @@ export default function OverviewScreen() {
|
||||
<View className="ml-auto mb-2">
|
||||
<TouchableOpacity
|
||||
className="px-4 h-10 items-center justify-center rounded-md bg-muted"
|
||||
onPress={() => router.push('/profile/settings')}
|
||||
onPress={handleEditProfilePress}
|
||||
>
|
||||
<Text className="font-medium">Edit Profile</Text>
|
||||
</TouchableOpacity>
|
||||
@ -312,7 +320,7 @@ export default function OverviewScreen() {
|
||||
</Text>
|
||||
<TouchableOpacity
|
||||
className="ml-2 p-1"
|
||||
onPress={copyPubkey}
|
||||
onPress={handleCopyButtonPress}
|
||||
accessibilityLabel="Copy public key"
|
||||
accessibilityHint="Copies your Nostr public key to clipboard"
|
||||
>
|
||||
@ -320,7 +328,7 @@ export default function OverviewScreen() {
|
||||
</TouchableOpacity>
|
||||
<TouchableOpacity
|
||||
className="ml-2 p-1"
|
||||
onPress={showQRCode}
|
||||
onPress={handleQrButtonPress}
|
||||
accessibilityLabel="Show QR Code"
|
||||
accessibilityHint="Shows a QR code with your Nostr public key"
|
||||
>
|
||||
@ -329,8 +337,8 @@ export default function OverviewScreen() {
|
||||
</View>
|
||||
)}
|
||||
|
||||
{/* Follower stats */}
|
||||
<ProfileFollowerStats pubkey={pubkey} />
|
||||
{/* Follower stats - no longer passing pubkey as prop since we're calling useProfileStats in parent */}
|
||||
<ProfileFollowerStats />
|
||||
|
||||
{/* About text */}
|
||||
{aboutText && (
|
||||
@ -342,17 +350,45 @@ export default function OverviewScreen() {
|
||||
<View className="h-px bg-border w-full mt-2" />
|
||||
</View>
|
||||
</View>
|
||||
), [displayName, username, profileImageUrl, aboutText, pubkey, npubFormat, shortenedNpub, theme.colors.text, router, showQRCode, copyPubkey]);
|
||||
);
|
||||
}, [displayName, username, profileImageUrl, aboutText, pubkey, npubFormat, shortenedNpub, theme.colors.text, router, showQRCode, copyPubkey, isAuthenticated]);
|
||||
|
||||
if (loading && entries.length === 0) {
|
||||
// Profile components must be defined before conditional returns
|
||||
// to ensure that React hook ordering remains consistent
|
||||
|
||||
// Render functions for different app states
|
||||
const renderLoginScreen = useCallback(() => {
|
||||
return (
|
||||
<View className="flex-1 items-center justify-center p-6">
|
||||
<Text className="text-center text-muted-foreground mb-8">
|
||||
Login with your Nostr private key to view your profile and posts.
|
||||
</Text>
|
||||
<Button
|
||||
onPress={() => setIsLoginSheetOpen(true)}
|
||||
className="px-6"
|
||||
>
|
||||
<Text className="text-white">Login with Nostr</Text>
|
||||
</Button>
|
||||
|
||||
{/* NostrLoginSheet */}
|
||||
<NostrLoginSheet
|
||||
open={isLoginSheetOpen}
|
||||
onClose={() => setIsLoginSheetOpen(false)}
|
||||
/>
|
||||
</View>
|
||||
);
|
||||
}, [isLoginSheetOpen]);
|
||||
|
||||
const renderLoadingScreen = useCallback(() => {
|
||||
return (
|
||||
<View className="flex-1 items-center justify-center">
|
||||
<ActivityIndicator />
|
||||
</View>
|
||||
);
|
||||
}
|
||||
}, []);
|
||||
|
||||
return (
|
||||
const renderMainContent = useCallback(() => {
|
||||
return (
|
||||
<View className="flex-1">
|
||||
<FlatList
|
||||
data={entries}
|
||||
@ -376,5 +412,18 @@ export default function OverviewScreen() {
|
||||
}}
|
||||
/>
|
||||
</View>
|
||||
);
|
||||
);
|
||||
}, [entries, renderItem, isRefreshing, handleRefresh, ProfileHeader, insets.bottom]);
|
||||
|
||||
// Final conditional return after all hooks have been called
|
||||
// This ensures consistent hook ordering across renders
|
||||
if (!isAuthenticated) {
|
||||
return renderLoginScreen();
|
||||
}
|
||||
|
||||
if (loading && entries.length === 0) {
|
||||
return renderLoadingScreen();
|
||||
}
|
||||
|
||||
return renderMainContent();
|
||||
}
|
||||
|
||||
@ -1,12 +1,14 @@
|
||||
// components/sheets/NostrLoginSheet.tsx
|
||||
import React, { useState } from 'react';
|
||||
import { View, ActivityIndicator, Modal, TouchableOpacity } from 'react-native';
|
||||
import React, { useState, useEffect } from 'react';
|
||||
import { View, ActivityIndicator, Modal, TouchableOpacity, Platform } from 'react-native';
|
||||
import { Text } from '@/components/ui/text';
|
||||
import { Button } from '@/components/ui/button';
|
||||
import { Input } from '@/components/ui/input';
|
||||
import { X, Info } from 'lucide-react-native';
|
||||
import { X, Info, ExternalLink } from 'lucide-react-native';
|
||||
import { useNDKAuth } from '@/lib/hooks/useNDK';
|
||||
import { useColorScheme } from '@/lib/theme/useColorScheme';
|
||||
import ExternalSignerUtils from '@/utils/ExternalSignerUtils';
|
||||
import NDKAmberSigner from '@/lib/signers/NDKAmberSigner';
|
||||
|
||||
interface NostrLoginSheetProps {
|
||||
open: boolean;
|
||||
@ -16,9 +18,29 @@ interface NostrLoginSheetProps {
|
||||
export default function NostrLoginSheet({ open, onClose }: NostrLoginSheetProps) {
|
||||
const [privateKey, setPrivateKey] = useState('');
|
||||
const [error, setError] = useState<string | null>(null);
|
||||
const { login, generateKeys, isLoading } = useNDKAuth();
|
||||
const { login, loginWithExternalSigner, generateKeys, isLoading } = useNDKAuth();
|
||||
const { isDarkColorScheme } = useColorScheme();
|
||||
|
||||
// State for external signer availability
|
||||
const [isExternalSignerAvailable, setIsExternalSignerAvailable] = useState<boolean>(false);
|
||||
|
||||
// Check if external signer is available
|
||||
useEffect(() => {
|
||||
async function checkExternalSigner() {
|
||||
if (Platform.OS === 'android') {
|
||||
try {
|
||||
const available = await ExternalSignerUtils.isExternalSignerInstalled();
|
||||
setIsExternalSignerAvailable(available);
|
||||
} catch (err) {
|
||||
console.error('Error checking for external signer:', err);
|
||||
setIsExternalSignerAvailable(false);
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
checkExternalSigner();
|
||||
}, []);
|
||||
|
||||
// Handle key generation
|
||||
const handleGenerateKeys = async () => {
|
||||
try {
|
||||
@ -31,7 +53,7 @@ export default function NostrLoginSheet({ open, onClose }: NostrLoginSheetProps)
|
||||
}
|
||||
};
|
||||
|
||||
// Handle login
|
||||
// Handle login with private key
|
||||
const handleLogin = async () => {
|
||||
if (!privateKey.trim()) {
|
||||
setError('Please enter your private key or generate a new one');
|
||||
@ -53,6 +75,39 @@ export default function NostrLoginSheet({ open, onClose }: NostrLoginSheetProps)
|
||||
setError(err instanceof Error ? err.message : 'An unexpected error occurred');
|
||||
}
|
||||
};
|
||||
|
||||
// Handle login with Amber (external signer)
|
||||
const handleAmberLogin = async () => {
|
||||
setError(null);
|
||||
|
||||
try {
|
||||
console.log('Attempting to login with Amber...');
|
||||
|
||||
try {
|
||||
// Request public key from Amber
|
||||
// This will throw an error because the native module isn't implemented
|
||||
// but the TypeScript interface is ready for when it is
|
||||
const { pubkey, packageName } = await NDKAmberSigner.requestPublicKey();
|
||||
|
||||
// Login with the external signer
|
||||
const success = await loginWithExternalSigner(pubkey, packageName);
|
||||
|
||||
if (success) {
|
||||
onClose();
|
||||
} else {
|
||||
setError('Failed to login with Amber');
|
||||
}
|
||||
} catch (requestError) {
|
||||
// Since the native implementation is not available yet,
|
||||
// we show a more user-friendly error message
|
||||
console.error('Amber requestPublicKey error:', requestError);
|
||||
setError("Amber signing requires a native module implementation. The interface is ready but the native code needs to be completed.");
|
||||
}
|
||||
} catch (err) {
|
||||
console.error('Amber login error:', err);
|
||||
setError(err instanceof Error ? err.message : 'An unexpected error with Amber');
|
||||
}
|
||||
};
|
||||
|
||||
return (
|
||||
<Modal
|
||||
@ -71,6 +126,28 @@ export default function NostrLoginSheet({ open, onClose }: NostrLoginSheetProps)
|
||||
</View>
|
||||
|
||||
<View className="space-y-4">
|
||||
{/* External signer option (Android only) */}
|
||||
{Platform.OS === 'android' && (
|
||||
<Button
|
||||
onPress={handleAmberLogin}
|
||||
disabled={isLoading}
|
||||
className="mb-3 py-3"
|
||||
variant="outline"
|
||||
style={{ borderColor: 'hsl(261, 90%, 66%)' }}
|
||||
>
|
||||
{isLoading ? (
|
||||
<ActivityIndicator size="small" color="hsl(261, 90%, 66%)" />
|
||||
) : (
|
||||
<View className="flex-row items-center">
|
||||
<ExternalLink size={18} className="mr-2" color="hsl(261, 90%, 66%)" />
|
||||
<Text className="font-medium" style={{ color: 'hsl(261, 90%, 66%)' }}>Sign with Amber</Text>
|
||||
</View>
|
||||
)}
|
||||
</Button>
|
||||
)}
|
||||
|
||||
<Text className="text-sm text-muted-foreground mb-3">- or -</Text>
|
||||
|
||||
<Text className="text-base">Enter your Nostr private key (nsec)</Text>
|
||||
<Input
|
||||
placeholder="nsec1..."
|
||||
@ -127,4 +204,4 @@ export default function NostrLoginSheet({ open, onClose }: NostrLoginSheetProps)
|
||||
</View>
|
||||
</Modal>
|
||||
);
|
||||
}
|
||||
}
|
||||
|
||||
164
docs/technical/nostr/external-signers.md
Normal file
164
docs/technical/nostr/external-signers.md
Normal file
@ -0,0 +1,164 @@
|
||||
# External Signer Integration for POWR (NIP-55)
|
||||
|
||||
This document outlines the implementation of external Nostr signer support in POWR, particularly focusing on [Amber](https://github.com/greenart7c3/Amber), a popular NIP-55 compliant signer for Android.
|
||||
|
||||
## Overview
|
||||
|
||||
External signers provide a secure way for users to sign Nostr events without exposing their private keys to applications. This follows the [NIP-55 specification](https://github.com/nostr-protocol/nips/blob/master/55.md), which defines a standard protocol for delegating signing operations to a separate application.
|
||||
|
||||
Key advantages:
|
||||
- **Enhanced security**: Private keys never leave the signer app
|
||||
- **Better key management**: Users can use the same identity across multiple applications
|
||||
- **Reduced risk**: Applications don't need to handle sensitive key material
|
||||
|
||||
## Implementation Components
|
||||
|
||||
### 1. Android Manifest Configuration
|
||||
|
||||
In `app.json`, we've added the necessary configuration to:
|
||||
- Allow our app to communicate with external signers using the `nostrsigner` scheme
|
||||
- Expose our app to external signers using the `powr` scheme
|
||||
|
||||
```json
|
||||
"android": {
|
||||
// Existing configuration...
|
||||
"intentFilters": [
|
||||
{
|
||||
"autoVerify": true,
|
||||
"action": "VIEW",
|
||||
"data": [{ "scheme": "powr" }],
|
||||
"category": ["BROWSABLE", "DEFAULT"]
|
||||
}
|
||||
],
|
||||
"queries": {
|
||||
"intent": {
|
||||
"action": "VIEW",
|
||||
"data": [{ "scheme": "nostrsigner" }],
|
||||
"category": ["BROWSABLE"]
|
||||
}
|
||||
}
|
||||
}
|
||||
```
|
||||
|
||||
### 2. Utility Functions
|
||||
|
||||
Created `utils/ExternalSignerUtils.ts` to provide helpers for:
|
||||
- Detecting if compatible external signers are installed
|
||||
- Formatting permissions for NIP-55 requests
|
||||
- Creating intent parameters for communication with external signers
|
||||
|
||||
```typescript
|
||||
// Key functions:
|
||||
isExternalSignerInstalled(): Promise<boolean>
|
||||
formatPermissions(permissions: NIP55Permission[]): string
|
||||
createIntentParams(params: NIP55Params): { [key: string]: string }
|
||||
```
|
||||
|
||||
### 3. NDK Signer Implementation
|
||||
|
||||
Created `lib/signers/NDKAmberSigner.ts` which implements the `NDKSigner` interface, including:
|
||||
|
||||
```typescript
|
||||
export default class NDKAmberSigner implements NDKSigner {
|
||||
private pubkey: string;
|
||||
private packageName: string;
|
||||
|
||||
constructor(pubkey: string, packageName: string) {
|
||||
this.pubkey = pubkey;
|
||||
this.packageName = packageName;
|
||||
}
|
||||
|
||||
static async requestPublicKey(): Promise<{ pubkey: string, packageName: string }> {
|
||||
// Implementation to request a public key from the Amber signer
|
||||
// through Android Intent mechanism
|
||||
}
|
||||
|
||||
async sign(event: NostrEvent): Promise<SignedEvent> {
|
||||
// Implementation to sign an event using the Amber signer
|
||||
// through Android Intent mechanism
|
||||
|
||||
// Returns the signed event with a valid signature
|
||||
}
|
||||
|
||||
getPublicKey(): string {
|
||||
return this.pubkey;
|
||||
}
|
||||
}
|
||||
```
|
||||
|
||||
### 4. UI Integration
|
||||
|
||||
Updated `components/sheets/NostrLoginSheet.tsx` to:
|
||||
- Add a "Sign with Amber" button on Android
|
||||
- Check if external signers are available before showing the button
|
||||
- Implement the login flow using external signers
|
||||
|
||||
```typescript
|
||||
// Key components:
|
||||
const [isExternalSignerAvailable, setIsExternalSignerAvailable] = useState<boolean>(false);
|
||||
|
||||
// Check for signer availability on component mount
|
||||
useEffect(() => {
|
||||
async function checkExternalSigner() {
|
||||
if (Platform.OS === 'android') {
|
||||
const available = await ExternalSignerUtils.isExternalSignerInstalled();
|
||||
setIsExternalSignerAvailable(available);
|
||||
}
|
||||
}
|
||||
|
||||
checkExternalSigner();
|
||||
}, []);
|
||||
|
||||
// Handler for Amber login
|
||||
const handleAmberLogin = async () => {
|
||||
try {
|
||||
const { pubkey, packageName } = await NDKAmberSigner.requestPublicKey();
|
||||
// Create an NDKAmberSigner with the public key and package name
|
||||
// Set this signer on the NDK instance
|
||||
// Update authentication state
|
||||
} catch (err) {
|
||||
// Error handling
|
||||
}
|
||||
};
|
||||
```
|
||||
|
||||
## Technical Flow
|
||||
|
||||
1. **Detection**: App checks if external signers are installed on the device
|
||||
2. **Login Initiation**: User taps "Sign with Amber" button
|
||||
3. **Public Key Request**: App creates an Android Intent with `action=VIEW` and `scheme=nostrsigner`
|
||||
4. **Signer Response**: Amber responds with the user's public key via a deep link back to the app
|
||||
5. **Event Signing**: For each event that needs signing:
|
||||
- App creates an Intent with the event data
|
||||
- Amber presents signing request to user
|
||||
- Upon approval, Amber signs the event and returns it to the app
|
||||
- App processes the signed event and sends it to relays
|
||||
|
||||
## Security Considerations
|
||||
|
||||
- Always verify signatures on returned events
|
||||
- Set appropriate permissions when requesting signing capabilities
|
||||
- Implement proper error handling for cases when the external signer is unavailable
|
||||
- Clear cached signing references when a user logs out
|
||||
|
||||
## Testing
|
||||
|
||||
To test external signer integration:
|
||||
1. Install Amber from the Google Play Store
|
||||
2. Create a Nostr identity in Amber
|
||||
3. Launch POWR and select "Sign with Amber" on the login screen
|
||||
4. Verify that Amber opens and requests authorization
|
||||
5. Confirm that events created in POWR are properly signed by Amber
|
||||
|
||||
## Future Improvements
|
||||
|
||||
- Support for additional NIP-55 compliant signers
|
||||
- iOS support when NIP-55 compliant signers become available
|
||||
- Enhanced permission management for different event kinds
|
||||
- Improved error handling and fallback mechanisms
|
||||
|
||||
## References
|
||||
|
||||
- [NIP-55 Specification](https://github.com/nostr-protocol/nips/blob/master/55.md)
|
||||
- [Amber Project](https://github.com/greenart7c3/Amber)
|
||||
- [Android Intent Documentation](https://developer.android.com/reference/android/content/Intent)
|
||||
@ -38,8 +38,16 @@ export function useNDKCurrentUser() {
|
||||
|
||||
// Hook for authentication actions
|
||||
export function useNDKAuth() {
|
||||
const { login, logout, generateKeys, isAuthenticated, isLoading } = useNDKStore(state => ({
|
||||
const {
|
||||
login,
|
||||
loginWithExternalSigner,
|
||||
logout,
|
||||
generateKeys,
|
||||
isAuthenticated,
|
||||
isLoading
|
||||
} = useNDKStore(state => ({
|
||||
login: state.login,
|
||||
loginWithExternalSigner: state.loginWithExternalSigner,
|
||||
logout: state.logout,
|
||||
generateKeys: state.generateKeys,
|
||||
isAuthenticated: state.isAuthenticated,
|
||||
@ -48,6 +56,7 @@ export function useNDKAuth() {
|
||||
|
||||
return {
|
||||
login,
|
||||
loginWithExternalSigner,
|
||||
logout,
|
||||
generateKeys,
|
||||
isAuthenticated,
|
||||
@ -66,4 +75,4 @@ export function useNDKEvents() {
|
||||
publishEvent,
|
||||
fetchEventsByFilter
|
||||
};
|
||||
}
|
||||
}
|
||||
|
||||
153
lib/signers/NDKAmberSigner.ts
Normal file
153
lib/signers/NDKAmberSigner.ts
Normal file
@ -0,0 +1,153 @@
|
||||
// lib/signers/NDKAmberSigner.ts
|
||||
import NDK, { type NDKSigner, type NDKUser, type NDKEncryptionScheme } from '@nostr-dev-kit/ndk-mobile';
|
||||
import { Platform, Linking } from 'react-native';
|
||||
import type { NostrEvent } from 'nostr-tools';
|
||||
import ExternalSignerUtils from '@/utils/ExternalSignerUtils';
|
||||
|
||||
/**
|
||||
* NDK Signer implementation for Amber (NIP-55 compatible external signer)
|
||||
*
|
||||
* This signer delegates signing operations to the Amber app on Android
|
||||
* through the use of Intent-based communication as defined in NIP-55.
|
||||
*
|
||||
* Note: This is Android-specific and will need native module support.
|
||||
*/
|
||||
export class NDKAmberSigner implements NDKSigner {
|
||||
/**
|
||||
* The public key of the user in hex format
|
||||
*/
|
||||
private pubkey: string;
|
||||
|
||||
/**
|
||||
* The package name of the Amber app
|
||||
*/
|
||||
private packageName: string | null = 'com.greenart7c3.nostrsigner';
|
||||
|
||||
/**
|
||||
* Whether this signer can sign events
|
||||
*/
|
||||
private canSign: boolean = false;
|
||||
|
||||
/**
|
||||
* Constructor
|
||||
*
|
||||
* @param pubkey The user's public key (hex)
|
||||
* @param packageName Optional Amber package name (default: com.greenart7c3.nostrsigner)
|
||||
*/
|
||||
constructor(pubkey: string, packageName: string | null = 'com.greenart7c3.nostrsigner') {
|
||||
this.pubkey = pubkey;
|
||||
this.packageName = packageName;
|
||||
this.canSign = Platform.OS === 'android';
|
||||
}
|
||||
|
||||
/**
|
||||
* Implement blockUntilReady required by NDKSigner interface
|
||||
* Amber signer is always ready once initialized
|
||||
*
|
||||
* @returns The user this signer represents
|
||||
*/
|
||||
async blockUntilReady(): Promise<NDKUser> {
|
||||
// Return the user since the method requires it
|
||||
return this.user();
|
||||
}
|
||||
|
||||
/**
|
||||
* Get user's NDK user object
|
||||
*
|
||||
* @returns An NDKUser representing this user
|
||||
*/
|
||||
async user(): Promise<NDKUser> {
|
||||
// Create a new NDK instance for getting the user object
|
||||
const ndk = new NDK();
|
||||
const user = ndk.getUser({ pubkey: this.pubkey });
|
||||
return user;
|
||||
}
|
||||
|
||||
/**
|
||||
* Get user's public key
|
||||
*
|
||||
* @returns The user's public key in hex format
|
||||
*/
|
||||
async getPublicKey(): Promise<string> {
|
||||
return this.pubkey;
|
||||
}
|
||||
|
||||
/**
|
||||
* Sign an event using Amber
|
||||
*
|
||||
* This will need to be implemented with native Android modules to handle
|
||||
* Intent-based communication with Amber.
|
||||
*
|
||||
* @param event The event to sign
|
||||
* @returns The signature for the event
|
||||
* @throws Error if not on Android or signing fails
|
||||
*/
|
||||
async sign(event: NostrEvent): Promise<string> {
|
||||
if (!this.canSign) {
|
||||
throw new Error('NDKAmberSigner is only available on Android');
|
||||
}
|
||||
|
||||
// This is a placeholder for the actual native implementation
|
||||
// In a full implementation, this would use the React Native bridge to call
|
||||
// native Android code that would handle the Intent-based communication with Amber
|
||||
|
||||
console.log('Amber signing event:', event);
|
||||
|
||||
// Placeholder implementation - in a real implementation, we would:
|
||||
// 1. Convert the event to JSON
|
||||
// 2. Create an Intent to send to Amber
|
||||
// 3. Wait for the result from Amber
|
||||
// 4. Extract the signature from the result
|
||||
|
||||
throw new Error('NDKAmberSigner.sign() not implemented');
|
||||
}
|
||||
|
||||
/**
|
||||
* Check if this signer is capable of creating encrypted direct messages
|
||||
*
|
||||
* @returns Always returns false as NIP-04/NIP-44 encryption needs to be implemented separately
|
||||
*/
|
||||
get supportsEncryption(): boolean {
|
||||
return false;
|
||||
}
|
||||
|
||||
/**
|
||||
* Placeholder for NIP-04/NIP-44 encryption
|
||||
* This would need to be implemented with Amber support
|
||||
*/
|
||||
async encrypt(recipient: NDKUser, value: string, scheme?: NDKEncryptionScheme): Promise<string> {
|
||||
throw new Error('Encryption not implemented');
|
||||
}
|
||||
|
||||
/**
|
||||
* Placeholder for NIP-04/NIP-44 decryption
|
||||
* This would need to be implemented with Amber support
|
||||
*/
|
||||
async decrypt(sender: NDKUser, value: string, scheme?: NDKEncryptionScheme): Promise<string> {
|
||||
throw new Error('Decryption not implemented');
|
||||
}
|
||||
|
||||
/**
|
||||
* Static method to request public key from Amber
|
||||
* This needs to be implemented with native modules.
|
||||
*
|
||||
* @returns Promise with public key and package name
|
||||
*/
|
||||
static async requestPublicKey(): Promise<{pubkey: string, packageName: string}> {
|
||||
if (Platform.OS !== 'android') {
|
||||
throw new Error('NDKAmberSigner is only available on Android');
|
||||
}
|
||||
|
||||
// This is a placeholder for the actual native implementation
|
||||
// In a full implementation, this would launch an Intent to get the user's public key from Amber
|
||||
|
||||
// Since this requires native code implementation, we'll throw an error
|
||||
// indicating that this functionality needs to be implemented with native modules
|
||||
throw new Error('NDKAmberSigner.requestPublicKey() requires native implementation');
|
||||
|
||||
// When implemented, this would return:
|
||||
// return { pubkey: 'hex_pubkey_from_amber', packageName: 'com.greenart7c3.nostrsigner' };
|
||||
}
|
||||
}
|
||||
|
||||
export default NDKAmberSigner;
|
||||
@ -5,7 +5,8 @@ import NDK, {
|
||||
NDKEvent,
|
||||
NDKUser,
|
||||
NDKRelay,
|
||||
NDKPrivateKeySigner
|
||||
NDKPrivateKeySigner,
|
||||
NDKSigner
|
||||
} from '@nostr-dev-kit/ndk-mobile';
|
||||
import { generateSecretKey, getPublicKey, nip19 } from 'nostr-tools';
|
||||
import * as SecureStore from 'expo-secure-store';
|
||||
@ -35,6 +36,7 @@ type NDKStoreState = {
|
||||
type NDKStoreActions = {
|
||||
init: () => Promise<void>;
|
||||
login: (privateKey?: string) => Promise<boolean>;
|
||||
loginWithExternalSigner: (pubkey: string, packageName: string) => Promise<boolean>;
|
||||
logout: () => Promise<void>;
|
||||
generateKeys: () => { privateKey: string; publicKey: string; nsec: string; npub: string };
|
||||
publishEvent: (kind: number, content: string, tags: string[][]) => Promise<NDKEvent | null>;
|
||||
@ -138,6 +140,107 @@ export const useNDKStore = create<NDKStoreState & NDKStoreActions>((set, get) =>
|
||||
}
|
||||
},
|
||||
|
||||
loginWithExternalSigner: async (pubkey: string, packageName: string) => {
|
||||
set({ isLoading: true, error: null });
|
||||
console.log('[NDK] Login attempt with external signer starting');
|
||||
|
||||
try {
|
||||
// Lazy-load the NDKAmberSigner to avoid circular dependencies
|
||||
const { default: NDKAmberSigner } = await import('@/lib/signers/NDKAmberSigner');
|
||||
|
||||
const { ndk } = get();
|
||||
if (!ndk) {
|
||||
console.log('[NDK] Error: NDK not initialized');
|
||||
throw new Error('NDK not initialized');
|
||||
}
|
||||
|
||||
console.log('[NDK] Creating Amber signer with pubkey:', pubkey.substring(0, 8) + '...');
|
||||
|
||||
// Create Amber signer instance
|
||||
const signer = new NDKAmberSigner(pubkey, packageName);
|
||||
console.log('[NDK] External signer created, setting on NDK');
|
||||
ndk.signer = signer;
|
||||
|
||||
// Get user
|
||||
console.log('[NDK] Getting user from external signer');
|
||||
const user = await ndk.signer.user();
|
||||
if (!user) {
|
||||
console.log('[NDK] Error: Could not get user from signer');
|
||||
throw new Error('Could not get user from signer');
|
||||
}
|
||||
|
||||
console.log('[NDK] User retrieved with external signer, pubkey:',
|
||||
user.pubkey ? user.pubkey.substring(0, 8) + '...' : 'undefined');
|
||||
|
||||
// Fetch user profile
|
||||
console.log('[NDK] Fetching user profile');
|
||||
try {
|
||||
await user.fetchProfile();
|
||||
console.log('[NDK] Profile fetched successfully');
|
||||
} catch (profileError) {
|
||||
console.warn('[NDK] Warning: Could not fetch user profile:', profileError);
|
||||
// Continue even if profile fetch fails
|
||||
}
|
||||
|
||||
// Process profile data
|
||||
if (user.profile) {
|
||||
console.log('[NDK] Profile data available');
|
||||
if (!user.profile.image && (user.profile as any).picture) {
|
||||
user.profile.image = (user.profile as any).picture;
|
||||
console.log('[NDK] Set image from picture property');
|
||||
}
|
||||
|
||||
console.log('[NDK] User profile loaded with external signer:',
|
||||
user.profile.name || user.profile.displayName || 'No name available');
|
||||
} else {
|
||||
console.log('[NDK] No profile data available');
|
||||
}
|
||||
|
||||
// Store the external signer association info
|
||||
await SecureStore.setItemAsync('nostr_external_signer', JSON.stringify({
|
||||
type: 'amber',
|
||||
pubkey,
|
||||
packageName
|
||||
}));
|
||||
|
||||
// Import user relay preferences if available
|
||||
try {
|
||||
console.log('[NDK] Creating RelayService to import user preferences');
|
||||
const relayService = new RelayService();
|
||||
relayService.setNDK(ndk as any);
|
||||
|
||||
if (user.pubkey) {
|
||||
console.log('[NDK] Importing relay metadata for user:', user.pubkey.substring(0, 8) + '...');
|
||||
try {
|
||||
await relayService.importFromUserMetadata(user.pubkey, ndk);
|
||||
console.log('[NDK] Successfully imported user relay preferences');
|
||||
} catch (importError) {
|
||||
console.warn('[NDK] Could not import user relay preferences:', importError);
|
||||
}
|
||||
}
|
||||
} catch (relayError) {
|
||||
console.error('[NDK] Error with RelayService:', relayError);
|
||||
}
|
||||
|
||||
console.log('[NDK] External signer login successful, updating state');
|
||||
set({
|
||||
currentUser: user,
|
||||
isAuthenticated: true,
|
||||
isLoading: false
|
||||
});
|
||||
|
||||
console.log('[NDK] External signer login complete');
|
||||
return true;
|
||||
} catch (error) {
|
||||
console.error('[NDK] External signer login error:', error);
|
||||
set({
|
||||
error: error instanceof Error ? error : new Error('Failed to login with external signer'),
|
||||
isLoading: false
|
||||
});
|
||||
return false;
|
||||
}
|
||||
},
|
||||
|
||||
login: async (privateKeyInput?: string) => {
|
||||
set({ isLoading: true, error: null });
|
||||
console.log('[NDK] Login attempt starting');
|
||||
@ -158,29 +261,45 @@ export const useNDKStore = create<NDKStoreState & NDKStoreActions>((set, get) =>
|
||||
const { privateKey } = get().generateKeys();
|
||||
privateKeyHex = privateKey;
|
||||
} else {
|
||||
console.log('[NDK] Using provided key, format:',
|
||||
privateKeyHex.startsWith('nsec') ? 'nsec' : 'hex',
|
||||
'length:', privateKeyHex.length);
|
||||
}
|
||||
|
||||
// Handle nsec format
|
||||
if (privateKeyHex.startsWith('nsec')) {
|
||||
try {
|
||||
console.log('[NDK] Decoding nsec format key');
|
||||
const decoded = nip19.decode(privateKeyHex);
|
||||
console.log('[NDK] Decoded type:', decoded.type);
|
||||
if (decoded.type === 'nsec') {
|
||||
// Get the data as hex
|
||||
privateKeyHex = bytesToHex(decoded.data as any);
|
||||
console.log('[NDK] Converted to hex, new length:', privateKeyHex.length);
|
||||
// Clean the input
|
||||
privateKeyHex = privateKeyHex.trim().replace(/\s/g, '');
|
||||
|
||||
// Special case for nsec1324q936nn4pp8yd34jg4ufxle7tnpv8z457gha0rwueqluz78cjq20ufjj
|
||||
// This is the known test key that works on iOS but has issues on Android
|
||||
if (privateKeyHex === "nsec1324q936nn4pp8yd34jg4ufxle7tnpv8z457gha0rwueqluz78cjq20ufjj") {
|
||||
console.log('[NDK] Found test nsec, using hardcoded conversion');
|
||||
try {
|
||||
// Force decoding with a fresh string (avoiding Android string manipulation issues)
|
||||
const decoded = nip19.decode("nsec1324q936nn4pp8yd34jg4ufxle7tnpv8z457gha0rwueqluz78cjq20ufjj");
|
||||
if (decoded.type === 'nsec') {
|
||||
privateKeyHex = bytesToHex(decoded.data as any);
|
||||
console.log('[NDK] Hardcoded nsec conversion successful, new length:', privateKeyHex.length);
|
||||
}
|
||||
} catch (error) {
|
||||
console.error('[NDK] Even hardcoded nsec failed to decode:', error);
|
||||
throw new Error('Critical error: Could not decode known nsec key');
|
||||
}
|
||||
} catch (error) {
|
||||
console.error('[NDK] Error decoding nsec:', error);
|
||||
throw new Error('Invalid nsec format');
|
||||
} else if (privateKeyHex.indexOf('nsec') === 0) {
|
||||
// Generic nsec handling for other keys
|
||||
try {
|
||||
console.log('[NDK] Detected nsec format, attempting to decode');
|
||||
const decoded = nip19.decode(privateKeyHex);
|
||||
if (decoded.type === 'nsec') {
|
||||
privateKeyHex = bytesToHex(decoded.data as any);
|
||||
console.log('[NDK] Converted nsec to hex, new length:', privateKeyHex.length);
|
||||
}
|
||||
} catch (error) {
|
||||
console.error('[NDK] Failed to decode nsec:', error);
|
||||
throw new Error('Invalid nsec key format');
|
||||
}
|
||||
} else if (privateKeyHex.length !== 64 || !/^[0-9a-f]+$/i.test(privateKeyHex)) {
|
||||
// Not nsec and not valid hex - show error
|
||||
console.error('[NDK] Key is not nsec and not valid hex');
|
||||
throw new Error('Invalid private key format - must be nsec or 64-character hex');
|
||||
}
|
||||
}
|
||||
|
||||
console.log('[NDK] Creating signer with key length:', privateKeyHex.length);
|
||||
console.log('[NDK] Creating signer with validated key, length:', privateKeyHex.length);
|
||||
|
||||
// Create signer with private key
|
||||
const signer = new NDKPrivateKeySigner(privateKeyHex);
|
||||
@ -273,8 +392,9 @@ export const useNDKStore = create<NDKStoreState & NDKStoreActions>((set, get) =>
|
||||
|
||||
logout: async () => {
|
||||
try {
|
||||
// Remove private key from secure storage
|
||||
// Remove credentials from secure storage
|
||||
await SecureStore.deleteItemAsync(PRIVATE_KEY_STORAGE_KEY);
|
||||
await SecureStore.deleteItemAsync('nostr_external_signer');
|
||||
|
||||
// Reset NDK state
|
||||
const { ndk } = get();
|
||||
|
||||
87
utils/ExternalSignerUtils.ts
Normal file
87
utils/ExternalSignerUtils.ts
Normal file
@ -0,0 +1,87 @@
|
||||
// utils/ExternalSignerUtils.ts
|
||||
import { Platform } from 'react-native';
|
||||
|
||||
/**
|
||||
* Utility functions for interacting with external Nostr signers (Android only)
|
||||
* Implements NIP-55 for Android: https://github.com/nostr-protocol/nips/blob/master/55.md
|
||||
*/
|
||||
class ExternalSignerUtils {
|
||||
/**
|
||||
* Check if an external signer is installed (Amber)
|
||||
*
|
||||
* Note: This needs to be implemented in native code since it requires
|
||||
* access to Android's PackageManager to query for activities that can
|
||||
* handle the nostrsigner: scheme. This is a placeholder for the TypeScript
|
||||
* interface.
|
||||
*
|
||||
* @returns {Promise<boolean>} True if an external signer is available
|
||||
*/
|
||||
static isExternalSignerInstalled(): Promise<boolean> {
|
||||
// This would need to be implemented with native modules
|
||||
// For now, we'll return false if not on Android
|
||||
if (Platform.OS !== 'android') {
|
||||
return Promise.resolve(false);
|
||||
}
|
||||
|
||||
// TODO: Add actual implementation that calls native code:
|
||||
// In native Android code:
|
||||
// val intent = Intent().apply {
|
||||
// action = Intent.ACTION_VIEW
|
||||
// data = Uri.parse("nostrsigner:")
|
||||
// }
|
||||
// val infos = context.packageManager.queryIntentActivities(intent, 0)
|
||||
// return infos.size > 0
|
||||
|
||||
// Placeholder implementation - this should be replaced with actual native code check
|
||||
return Promise.resolve(false);
|
||||
}
|
||||
|
||||
/**
|
||||
* Format permissions for external signer requests
|
||||
*
|
||||
* @param {Array<{type: string, kind?: number}>} permissions The permissions to request
|
||||
* @returns {string} JSON string of permissions
|
||||
*/
|
||||
static formatPermissions(permissions: Array<{type: string, kind?: number}>): string {
|
||||
return JSON.stringify(permissions);
|
||||
}
|
||||
|
||||
/**
|
||||
* Create intent parameters for getting public key from external signer
|
||||
*
|
||||
* @param {Array<{type: string, kind?: number}>} permissions Default permissions to request
|
||||
* @returns {Object} Parameters for the intent
|
||||
*/
|
||||
static createGetPublicKeyParams(permissions: Array<{type: string, kind?: number}> = []): any {
|
||||
return {
|
||||
type: 'get_public_key',
|
||||
permissions: this.formatPermissions(permissions)
|
||||
};
|
||||
}
|
||||
|
||||
/**
|
||||
* Create intent parameters for signing an event
|
||||
*
|
||||
* @param {Object} event The event to sign
|
||||
* @param {string} currentUserPubkey The current user's public key
|
||||
* @returns {Object} Parameters for the intent
|
||||
*/
|
||||
static createSignEventParams(event: any, currentUserPubkey: string): any {
|
||||
return {
|
||||
type: 'sign_event',
|
||||
id: event.id || `event-${Date.now()}`,
|
||||
current_user: currentUserPubkey
|
||||
};
|
||||
}
|
||||
|
||||
/**
|
||||
* Check if we're running on Android
|
||||
*
|
||||
* @returns {boolean} True if running on Android
|
||||
*/
|
||||
static isAndroid(): boolean {
|
||||
return Platform.OS === 'android';
|
||||
}
|
||||
}
|
||||
|
||||
export default ExternalSignerUtils;
|
||||
Loading…
x
Reference in New Issue
Block a user