README.mdの更新

VWBL · May 20, 2024 · aa10a29 · aa10a29
1 parent b7ef500
commit aa10a29
Show file tree

Hide file tree

Showing 2 changed files with 16 additions and 3 deletions.
diff --git a/README.md b/README.md
@@ -45,9 +45,9 @@ Constructor Options
 | uploadContentType  | flase                                                    | UploadContentType                          | where to upload content, you can choose from <br> S3 <br> IPFS <br> CUSTOM                                                                            |
 | uploadMetadataType | flase                                                    | UploadMetadataType                         | where to upload content, you can choose from <br> S3 <br> IPFS <br> CUSTOM                                                                            |
 | awsConfig          | true if you choose to upload content or metadata to S3   | AWSConfig                                  | AWSConfig \*1                                                                                                                                         |
-| ipfsNftStorageKey  | true if you choose to upload content or metadata to IPFS | string                                     | api key that given by nftstorage                                                                                                                      |
+| ipfsConfig  | true if you choose to upload content or metadata to IPFS | IPFSConfig                                     | IPFSConfig \*2                                                                                                                     |
 
-AWSConfig
+AWSConfig(*1)
 
 | name          | required | type                                | description                                               |
 | ------------- | -------- | ----------------------------------- | --------------------------------------------------------- |
@@ -56,6 +56,19 @@ AWSConfig
 | cloudFrontUrl | true     | string                              | cloudFront url connect to s3 which is uploaded content    |
 | bucketName    | true     | {content: string, metadata: string} | bucketName of metadata and content, it's ok they are same |
 
+export type IPFSConfig = {
+  apiKey: string;
+  apiSecret?: string;
+};
+
+
+IPFSConfig(*1)
+
+| name          | required | type                                | description                                               |
+| ------------- | -------- | ----------------------------------- | --------------------------------------------------------- |
+| apiKey        | true     | string                              | API key region                                                |
+| apiSecret      | false     | string                              | API Secret key  S3-put-object                  |
+|
 ### sign to server
 
 Signing is necessary before creating token or viewing contents.

diff --git a/src/vwbl/types/File.ts b/src/vwbl/types/File.ts
@@ -23,7 +23,7 @@ type UploadMetadata = (
 
 type UploadEncryptedFileToIPFS = (encryptedContent: string | ArrayBuffer, ipfsConfig?: IPFSConfig) => Promise<string>;
 
-type UploadThumbnailToIPFS = (thumbnailImage: FileOrPath) => Promise<string>;
+type UploadThumbnailToIPFS = (thumbnailImage: FileOrPath, ipfsConfig?: IPFSConfig) => Promise<string>;
 
 type UploadMetadataToIPFS = (
   name: string,