Repository navigation
Expand file tree
/
Copy pathipfs.ts
More file actions
450 lines (398 loc) · 11.5 KB
/
Copy pathipfs.ts
File metadata and controls
450 lines (398 loc) · 11.5 KB
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
import axios from 'axios';
// Types for IPFS operations
export interface IpfsUploadOptions {
metadata?: Record<string, any>;
includeMetadata?: boolean;
wrapWithDirectory?: boolean;
onProgress?: (progress: UploadProgress) => void;
}
export interface UploadProgress {
progress: number;
bytesLoaded: number;
bytesTotal: number;
isComplete: boolean;
fileIndex?: number;
totalFiles?: number;
overallProgress?: number;
}
export interface IpfsUploadResult {
cid: string;
metadataCid?: string;
metadata: Record<string, any>;
size: number;
gatewayUrl: string;
}
export interface IpfsContentResult {
cid: string;
content: string | ArrayBuffer;
size: number;
contentType?: string;
}
export interface IpfsMetadata {
name: string;
size: number;
contentType: string;
uploadedAt: string;
contentHash: string;
uploader?: {
id: string;
username: string;
address: string;
};
[key: string]: any;
}
export interface IpfsNodeInfo {
version: {
version: string;
commit: string;
repo: string;
};
id: {
id: string;
addresses: string[];
};
repo: {
numObjects: number;
repoSize: number;
storageMax: number;
};
config: {
host: string;
port: number;
protocol: string;
};
}
export interface IpfsCacheStats {
totalEntries: number;
validEntries: number;
expiredEntries: number;
cacheSize: number;
}
export interface IpfsError extends Error {
operation?: string;
details?: any;
isIpfsError?: boolean;
}
/**
* Frontend IPFS Client
* Provides a clean interface for interacting with the IPFS backend API
*/
class IpfsClient {
private baseURL: string;
private authToken: string | null = null;
constructor(baseURL: string = 'http://localhost:3001/api/content') {
this.baseURL = baseURL;
}
/**
* Set authentication token for IPFS operations
* @param token - JWT token
*/
setAuthToken(token: string): void {
this.authToken = token;
}
/**
* Clear authentication token
*/
clearAuthToken(): void {
this.authToken = null;
}
/**
* Get authorization headers
*/
private getAuthHeaders(): Record<string, string> {
const headers: Record<string, string> = {
'Content-Type': 'application/json',
};
if (this.authToken) {
headers['Authorization'] = `Bearer ${this.authToken}`;
}
return headers;
}
/**
* Handle IPFS API errors
*/
private handleError(error: any): IpfsError {
if (error.response) {
const { data, status } = error.response;
if (data.isIpfsError) {
const ipfsError = new Error(data.message) as IpfsError;
ipfsError.operation = data.operation;
ipfsError.details = data.details;
ipfsError.isIpfsError = true;
return ipfsError;
}
const apiError = new Error(data.message || 'API request failed') as IpfsError;
apiError.details = { status, data };
return apiError;
}
const networkError = new Error('Network error occurred') as IpfsError;
networkError.details = error;
return networkError;
}
/**
* Upload a single file to IPFS
* @param file - File to upload
* @param options - Upload options
* @returns Promise<IpfsUploadResult>
*/
async uploadFile(file: File, options: IpfsUploadOptions = {}): Promise<IpfsUploadResult> {
try {
const formData = new FormData();
formData.append('file', file);
// Add metadata if provided
if (options.metadata) {
formData.append('metadata', JSON.stringify(options.metadata));
}
// Add other options
if (options.includeMetadata !== undefined) {
formData.append('includeMetadata', options.includeMetadata.toString());
}
if (options.wrapWithDirectory !== undefined) {
formData.append('wrapWithDirectory', options.wrapWithDirectory.toString());
}
const response = await axios.post(`${this.baseURL}/upload`, formData, {
headers: {
...this.getAuthHeaders(),
'Content-Type': 'multipart/form-data',
},
onUploadProgress: (progressEvent) => {
if (options.onProgress && progressEvent.total) {
const progress = {
progress: Math.round((progressEvent.loaded * 100) / progressEvent.total),
bytesLoaded: progressEvent.loaded,
bytesTotal: progressEvent.total,
isComplete: progressEvent.loaded >= progressEvent.total,
};
options.onProgress(progress);
}
},
});
return response.data.data;
} catch (error) {
throw this.handleError(error);
}
}
/**
* Upload multiple files to IPFS
* @param files - Files to upload
* @param options - Upload options
* @returns Promise<Array<Partial<IpfsUploadResult> & { success: boolean; error?: string }>>
*/
async uploadMultipleFiles(
files: File[],
options: IpfsUploadOptions = {}
): Promise<Array<Partial<IpfsUploadResult> & { success: boolean; error?: string }>> {
try {
const formData = new FormData();
// Add all files
files.forEach(file => {
formData.append('files', file);
});
// Add metadata if provided
if (options.metadata) {
formData.append('metadata', JSON.stringify(options.metadata));
}
// Add other options
if (options.includeMetadata !== undefined) {
formData.append('includeMetadata', options.includeMetadata.toString());
}
if (options.wrapWithDirectory !== undefined) {
formData.append('wrapWithDirectory', options.wrapWithDirectory.toString());
}
const response = await axios.post(`${this.baseURL}/upload/batch`, formData, {
headers: {
...this.getAuthHeaders(),
'Content-Type': 'multipart/form-data',
},
onUploadProgress: (progressEvent) => {
if (options.onProgress && progressEvent.total) {
const progress = {
progress: Math.round((progressEvent.loaded * 100) / progressEvent.total),
bytesLoaded: progressEvent.loaded,
bytesTotal: progressEvent.total,
isComplete: progressEvent.loaded >= progressEvent.total,
fileIndex: 0, // Will be updated by backend
totalFiles: files.length,
overallProgress: Math.round((progressEvent.loaded * 100) / progressEvent.total),
};
options.onProgress(progress);
}
},
});
return response.data.data.results;
} catch (error) {
throw this.handleError(error);
}
}
/**
* Retrieve content from IPFS
* @param cid - IPFS CID
* @param format - Response format ('buffer', 'base64', 'stream')
* @param bypassCache - Whether to bypass cache
* @returns Promise<IpfsContentResult>
*/
async getContent(
cid: string,
format: 'buffer' | 'base64' | 'stream' = 'buffer',
bypassCache: boolean = false
): Promise<IpfsContentResult> {
try {
const params = new URLSearchParams({
format,
...(bypassCache && { bypassCache: 'true' }),
});
const response = await axios.get(`${this.baseURL}/${cid}?${params}`, {
headers: this.getAuthHeaders(),
responseType: format === 'buffer' ? 'arraybuffer' : 'json',
});
if (format === 'base64') {
return response.data.data;
} else {
// For buffer and stream formats
return {
cid,
content: response.data,
size: response.data.byteLength || 0,
};
}
} catch (error) {
throw this.handleError(error);
}
}
/**
* Retrieve metadata for IPFS content
* @param cid - IPFS CID
* @param metadataCid - Metadata CID
* @returns Promise<IpfsMetadata>
*/
async getMetadata(cid: string, metadataCid: string): Promise<IpfsMetadata> {
try {
const params = new URLSearchParams({ metadataCid });
const response = await axios.get(`${this.baseURL}/${cid}/metadata?${params}`, {
headers: this.getAuthHeaders(),
});
return response.data.data.metadata;
} catch (error) {
throw this.handleError(error);
}
}
/**
* Pin content to IPFS
* @param cid - IPFS CID to pin
* @returns Promise<{ cid: string; pinned: boolean; timestamp: string }>
*/
async pinContent(cid: string): Promise<{ cid: string; pinned: boolean; timestamp: string }> {
try {
const response = await axios.post(`${this.baseURL}/${cid}/pin`, {}, {
headers: this.getAuthHeaders(),
});
return response.data.data;
} catch (error) {
throw this.handleError(error);
}
}
/**
* Unpin content from IPFS
* @param cid - IPFS CID to unpin
* @returns Promise<{ cid: string; unpinned: boolean; timestamp: string }>
*/
async unpinContent(cid: string): Promise<{ cid: string; unpinned: boolean; timestamp: string }> {
try {
const response = await axios.delete(`${this.baseURL}/${cid}/pin`, {
headers: this.getAuthHeaders(),
});
return response.data.data;
} catch (error) {
throw this.handleError(error);
}
}
/**
* Get IPFS node information
* @returns Promise<IpfsNodeInfo>
*/
async getNodeInfo(): Promise<IpfsNodeInfo> {
try {
const response = await axios.get(`${this.baseURL}/node/info`, {
headers: this.getAuthHeaders(),
});
return response.data.data;
} catch (error) {
throw this.handleError(error);
}
}
/**
* Get cache statistics
* @returns Promise<IpfsCacheStats>
*/
async getCacheStats(): Promise<IpfsCacheStats> {
try {
const response = await axios.get(`${this.baseURL}/cache/stats`, {
headers: this.getAuthHeaders(),
});
return response.data.data;
} catch (error) {
throw this.handleError(error);
}
}
/**
* Clear cache
* @returns Promise<{ message: string }>
*/
async clearCache(): Promise<{ message: string }> {
try {
const response = await axios.delete(`${this.baseURL}/cache`, {
headers: this.getAuthHeaders(),
});
return response.data;
} catch (error) {
throw this.handleError(error);
}
}
/**
* Check IPFS service health
* @returns Promise<{ success: boolean; status: string; data?: any }>
*/
async checkHealth(): Promise<{ success: boolean; status: string; data?: any }> {
try {
const response = await axios.get(`${this.baseURL}/health`);
return response.data;
} catch (error) {
throw this.handleError(error);
}
}
/**
* Format IPFS hash for gateway access
* @param cid - IPFS CID
* @param gatewayUrl - Custom gateway URL (optional)
* @returns Gateway URL string
*/
static formatGatewayUrl(cid: string, gatewayUrl: string = 'https://ipfs.io/ipfs/'): string {
return `${gatewayUrl}${cid}`;
}
/**
* Extract IPFS hash from gateway URL
* @param gatewayUrl - Gateway URL
* @returns IPFS hash or null
*/
static extractHashFromGatewayUrl(gatewayUrl: string): string | null {
const match = gatewayUrl.match(/\/ipfs\/(.+)$/);
return match ? match[1] : null;
}
/**
* Validate IPFS CID format
* @param cid - IPFS CID to validate
* @returns boolean indicating validity
*/
static isValidCid(cid: string): boolean {
if (!cid || typeof cid !== 'string') {
return false;
}
// Basic CID validation (can be enhanced with proper CID library)
const hash = this.extractHashFromGatewayUrl(cid) || cid;
return /^[a-zA-Z0-9]{46,}$/.test(hash);
}
}
// Create singleton instance
const ipfsClient = new IpfsClient();
export default ipfsClient;
export { IpfsClient };