メインコンテンツまでスキップ

Uploader-Basic

概要​

Uploader Basic SDK は、オフチェーンの NFT データ（メタデータ、画像やその他のアセットなど）を簡単にアップロードするためのライブラリです。データはNFT.storage上に保存されます。これはIPFSとFileCoinにアセットを保存するよう設計された長期ストレージサービスす。

ライブラリを利用するには、NFT.storage の API key が必要です。お持ちでない場合は、こちらから登録してください。

インストール方法​

npm install @gusdk/uploader-basic

利用方法​

あなたの API key で SDK インスタンスを作成します。

const { GUUploaderBasic } = require("@gusdk/uploader-basic");
const uploader = new GUUploaderBasic({ nftStorageToken: "YOUR_API_KEY" });

以下のコマンドで NFT メタデータを保存します。

const response = await uploader.storeMetadata({
  name: "enter your work name",
  description: "enter your work detail",
  imagePath: "/path/to/your/work.jpg",
});

以下のようなレスポンスが取得できます:

Token {
  ipnft: 'bafyreihy7g6qap2gphinbdwy47w367yqsfhphgtlfgrqsujrztlxilq3em',
  url: 'ipfs://bafyreihy7g6qap2gphinbdwy47w367yqsfhphgtlfgrqsujrztlxilq3em/metadata.json'
}
  • あなたの IPFS cid: bafyreihy7g6qap2gphinbdwy47w367yqsfhphgtlfgrqsujrztlxilq3em
  • あなたの IPFS uri: ipfs://bafyreihy7g6qap2gphinbdwy47w367yqsfhphgtlfgrqsujrztlxilq3em/metadata.json

Brave ブラウザ や 利用可能な IPFS ゲートウェイで確認できます。

関数一覧​

storeMetadata​

export interface BasicNFTMetadata {
    name: string;
    description: string;
    imagePath: string;
}
storeMetadata(metadata: BasicNFTMetadata): Promise<Token>;

NFT メタデータを IPFS に保存します。

storeFile​

    storeFile(imagePath: string): Promise<CIDString>;

IPFS 上のパスを指定して NFT の任意ファイルを保存します。

storeFile​

storeFiles(directoryPath: string): Promise<CIDString>;

IPFS 上のパスを指定して NFT の任意フォルダを保存します。

get nftStorageService​

  get nftStorageService(): NFTStorage;

NFT.storage インスタンスを取得して、NFT.storage のビルトイン API を利用できます。API はこちらから確認できます。