【XRPL対応】mintメソッドの実装

.eslintignore

@@ -0,0 +1,3 @@
+node_modules/**/*
+.eslintrc.*
+**/test/**/*

.github/workflows/ci.yml

@@ -2,7 +2,7 @@ name: Lint & Test
 
 on:
   pull_request:
-    branches: "*"
+    branches: ["*"]
 
 jobs:
   ci:

package.json

@@ -16,6 +16,7 @@
     "build:all": "nx run-many --target=build --all",
     "build:core": "nx build vwbl-core",
     "build:evm": "nx build vwbl-sdk",
+    "build:xrpl": "nx build vwbl-sdk-xrpl",
     "lint:all": "npm run lint -ws",
     "lint:core": "npm run lint -w vwbl-core",
     "lint:evm": "npm run lint -w vwbl-sdk",
@@ -28,12 +29,17 @@
   },
   "devDependencies": {
     "@eslint/js": "^9.4.0",
-    "@types/eslint__js": "^8.42.3",
     "@nx/js": "19.3.0",
+    "@types/eslint__js": "^8.42.3",
     "eslint": "^8.57.0",
     "nx": "19.3.0",
+    "ts-node": "^10.9.2",
     "typescript": "^5.4.5",
     "typescript-eslint": "^7.13.0"
   },
-  "nx": {}
+  "nx": {},
+  "dependencies": {
+    "dotenv": "^16.4.5",
+    "xumm-sdk": "^1.11.1"
+  }
 }

packages/core/src/storage/aws/upload.ts

@@ -81,7 +81,7 @@ export const uploadThumbnail = async (
 };
 
 export const uploadMetadata = async (
-  tokenId: number,
+  tokenId: string | number,
   name: string,
   description: string,
   previewImageUrl: string,

packages/core/src/vwbl/metadata/type.ts

@@ -27,6 +27,6 @@ export type ExtractMetadata = Metadata & {
   ownFiles: ArrayBuffer[] | Stream[];
 };
 
-export type ExtendedMetadeta = Metadata & {
+export type ExtendedMetadata = Metadata & {
   address: string;
 };

packages/core/src/vwbl/types/File.ts

@@ -12,7 +12,7 @@ type UploadEncryptedFile = (
 type UploadThumbnail = (thumbnailImage: FileOrPath, uuid: string) => Promise<string>;
 
 type UploadMetadata = (
-  tokenId: number,
+  tokenId: string | number,
   name: string,
   description: string,
   previewImageUrl: string,

packages/evm/src/index.ts

@@ -7,7 +7,7 @@ export {
   PlainMetadata,
   Metadata,
   ExtractMetadata,
-  ExtendedMetadeta,
+  ExtendedMetadata,
   EncryptLogic,
   UploadEncryptedFile,
   UploadThumbnail,

packages/evm/src/vwbl/viewer.ts

@@ -3,7 +3,7 @@ import axios from "axios";
 import { ethers } from "ethers";
 
 import vwblDataCollector from "../contract/VWBLDataCollector.json";
-import { ExtendedMetadeta, PlainMetadata } from "vwbl-core";
+import { ExtendedMetadata, PlainMetadata } from "vwbl-core";
 import { ViewerConstructorProps, ViewerOption } from "./types";
 
 type TokenInfo = {
@@ -22,17 +22,31 @@ export class VWBLViewer {
     this.dataCollector =
       "eth" in provider
         ? new provider.eth.Contract(vwblDataCollector.abi, dataCollectorAddress)
-        : new ethers.Contract(dataCollectorAddress, vwblDataCollector.abi, provider);
+        : new ethers.Contract(
+            dataCollectorAddress,
+            vwblDataCollector.abi,
+            provider
+          );
   }
 
-  getMetadata = async (contractAddress: string, tokenId: number): Promise<ExtendedMetadeta | undefined> => {
+  getMetadata = async (
+    contractAddress: string,
+    tokenId: number
+  ): Promise<ExtendedMetadata | undefined> => {
     if (!this.dataCollector) throw new Error("please set dataCollectorAddress");
     const metadataUrl =
       "callStatic" in this.dataCollector
-        ? await this.dataCollector.callStatic.getTokenURI(contractAddress, tokenId)
-        : await this.dataCollector.methods.getTokenURI(contractAddress, tokenId).call();
+        ? await this.dataCollector.callStatic.getTokenURI(
+            contractAddress,
+            tokenId
+          )
+        : await this.dataCollector.methods
+            .getTokenURI(contractAddress, tokenId)
+            .call();
     if (!metadataUrl) return undefined;
-    const metadata: PlainMetadata = (await axios.get(metadataUrl).catch(() => undefined))?.data;
+    const metadata: PlainMetadata = (
+      await axios.get(metadataUrl).catch(() => undefined)
+    )?.data;
     if (!metadata) return undefined;
     return {
       id: tokenId,
@@ -45,15 +59,23 @@ export class VWBLViewer {
     };
   };
 
-  listMetadata = async (contractAddress: string): Promise<(ExtendedMetadeta | undefined)[]> => {
+  listMetadata = async (
+    contractAddress: string
+  ): Promise<(ExtendedMetadata | undefined)[]> => {
     if (!this.dataCollector) throw new Error("please set dataCollectorAddress");
     const tokens =
       "callStatic" in this.dataCollector
-        ? await this.dataCollector.callStatic.getAllTokensFromOptionalContract(contractAddress)
-        : await this.dataCollector.methods.getAllTokensFromOptionalContract(contractAddress).call();
-    const items: (ExtendedMetadeta | undefined)[] = await Promise.all(
+        ? await this.dataCollector.callStatic.getAllTokensFromOptionalContract(
+            contractAddress
+          )
+        : await this.dataCollector.methods
+            .getAllTokensFromOptionalContract(contractAddress)
+            .call();
+    const items: (ExtendedMetadata | undefined)[] = await Promise.all(
       tokens.map(async (token: TokenInfo) => {
-        const metadata: PlainMetadata = (await axios.get(token.tokenURI).catch(() => undefined))?.data;
+        const metadata: PlainMetadata = (
+          await axios.get(token.tokenURI).catch(() => undefined)
+        )?.data;
         if (!metadata) return undefined;
         return {
           id: token.tokenId,
@@ -69,25 +91,33 @@ export class VWBLViewer {
     return items;
   };
 
-  listMetadataFormMultiContracts = async (contracts: string[]): Promise<(ExtendedMetadeta | undefined)[]> => {
+  listMetadataFormMultiContracts = async (
+    contracts: string[]
+  ): Promise<(ExtendedMetadata | undefined)[]> => {
     if (!this.dataCollector) throw new Error("please set dataCollectorAddress");
-    const allItems: (ExtendedMetadeta | undefined)[] = [];
+    const allItems: (ExtendedMetadata | undefined)[] = [];
     for (const addr of contracts) {
       const items = await this.listMetadata(addr);
       allItems.push(...items);
     }
     return allItems;
   };
 
-  listAllOwnedMetadata = async (userAddress: string): Promise<(ExtendedMetadeta | undefined)[]> => {
+  listAllOwnedMetadata = async (
+    userAddress: string
+  ): Promise<(ExtendedMetadata | undefined)[]> => {
     if (!this.dataCollector) throw new Error("please set dataCollectorAddress");
     const tokens =
       "callStatic" in this.dataCollector
         ? await this.dataCollector.callStatic.getAllOwnedTokens(userAddress)
-        : await this.dataCollector.methods.getAllOwnedTokens(userAddress).call();
-    const items: (ExtendedMetadeta | undefined)[] = await Promise.all(
+        : await this.dataCollector.methods
+            .getAllOwnedTokens(userAddress)
+            .call();
+    const items: (ExtendedMetadata | undefined)[] = await Promise.all(
       tokens.map(async (token: TokenInfo) => {
-        const metadata: PlainMetadata = (await axios.get(token.tokenURI).catch(() => undefined))?.data;
+        const metadata: PlainMetadata = (
+          await axios.get(token.tokenURI).catch(() => undefined)
+        )?.data;
         if (!metadata) return undefined;
         return {
           id: token.tokenId,
@@ -103,15 +133,19 @@ export class VWBLViewer {
     return items;
   };
 
-  listOwnedNFTMetadata = async (userAddress: string): Promise<(ExtendedMetadeta | undefined)[]> => {
+  listOwnedNFTMetadata = async (
+    userAddress: string
+  ): Promise<(ExtendedMetadata | undefined)[]> => {
     if (!this.dataCollector) throw new Error("please set dataCollectorAddress");
     const tokens =
       "callStatic" in this.dataCollector
         ? await this.dataCollector.callStatic.getOwnedNFTs(userAddress)
         : await this.dataCollector.methods.getOwnedNFTs(userAddress).call();
-    const items: (ExtendedMetadeta | undefined)[] = await Promise.all(
+    const items: (ExtendedMetadata | undefined)[] = await Promise.all(
       tokens.map(async (token: TokenInfo) => {
-        const metadata: PlainMetadata = (await axios.get(token.tokenURI).catch(() => undefined))?.data;
+        const metadata: PlainMetadata = (
+          await axios.get(token.tokenURI).catch(() => undefined)
+        )?.data;
         if (!metadata) return undefined;
         return {
           id: token.tokenId,
@@ -127,15 +161,19 @@ export class VWBLViewer {
     return items;
   };
 
-  listOwnedERC1155Metadata = async (userAddress: string): Promise<(ExtendedMetadeta | undefined)[]> => {
+  listOwnedERC1155Metadata = async (
+    userAddress: string
+  ): Promise<(ExtendedMetadata | undefined)[]> => {
     if (!this.dataCollector) throw new Error("please set dataCollectorAddress");
     const tokens =
       "callStatic" in this.dataCollector
         ? await this.dataCollector.callStatic.getOwnedERC1155s(userAddress)
         : await this.dataCollector.methods.getOwnedERC1155s(userAddress).call();
-    const items: (ExtendedMetadeta | undefined)[] = await Promise.all(
+    const items: (ExtendedMetadata | undefined)[] = await Promise.all(
       tokens.map(async (token: TokenInfo) => {
-        const metadata: PlainMetadata = (await axios.get(token.tokenURI).catch(() => undefined))?.data;
+        const metadata: PlainMetadata = (
+          await axios.get(token.tokenURI).catch(() => undefined)
+        )?.data;
         if (!metadata) return undefined;
         return {
           id: token.tokenId,
@@ -151,15 +189,21 @@ export class VWBLViewer {
     return items;
   };
 
-  listAllMintedMetadata = async (userAddress: string): Promise<(ExtendedMetadeta | undefined)[]> => {
+  listAllMintedMetadata = async (
+    userAddress: string
+  ): Promise<(ExtendedMetadata | undefined)[]> => {
     if (!this.dataCollector) throw new Error("please set dataCollectorAddress");
     const tokens =
       "callStatic" in this.dataCollector
         ? await this.dataCollector.callStatic.getAllMintedTokens(userAddress)
-        : await this.dataCollector.methods.getAllMintedTokens(userAddress).call();
-    const items: (ExtendedMetadeta | undefined)[] = await Promise.all(
+        : await this.dataCollector.methods
+            .getAllMintedTokens(userAddress)
+            .call();
+    const items: (ExtendedMetadata | undefined)[] = await Promise.all(
       tokens.map(async (token: TokenInfo) => {
-        const metadata: PlainMetadata = (await axios.get(token.tokenURI).catch(() => undefined))?.data;
+        const metadata: PlainMetadata = (
+          await axios.get(token.tokenURI).catch(() => undefined)
+        )?.data;
         if (!metadata) return undefined;
         return {
           id: token.tokenId,
@@ -175,15 +219,19 @@ export class VWBLViewer {
     return items;
   };
 
-  listMintedNFTMetadata = async (userAddress: string): Promise<(ExtendedMetadeta | undefined)[]> => {
+  listMintedNFTMetadata = async (
+    userAddress: string
+  ): Promise<(ExtendedMetadata | undefined)[]> => {
     if (!this.dataCollector) throw new Error("please set dataCollectorAddress");
     const tokens =
       "callStatic" in this.dataCollector
         ? await this.dataCollector.callStatic.getMintedNFTs(userAddress)
         : await this.dataCollector.methods.getMintedNFTs(userAddress).call();
-    const items: (ExtendedMetadeta | undefined)[] = await Promise.all(
+    const items: (ExtendedMetadata | undefined)[] = await Promise.all(
       tokens.map(async (token: TokenInfo) => {
-        const metadata: PlainMetadata = (await axios.get(token.tokenURI).catch(() => undefined))?.data;
+        const metadata: PlainMetadata = (
+          await axios.get(token.tokenURI).catch(() => undefined)
+        )?.data;
         if (!metadata) return undefined;
         return {
           id: token.tokenId,
@@ -199,15 +247,21 @@ export class VWBLViewer {
     return items;
   };
 
-  listMintedERC1155Metadata = async (userAddress: string): Promise<(ExtendedMetadeta | undefined)[]> => {
+  listMintedERC1155Metadata = async (
+    userAddress: string
+  ): Promise<(ExtendedMetadata | undefined)[]> => {
     if (!this.dataCollector) throw new Error("please set dataCollectorAddress");
     const tokens =
       "callStatic" in this.dataCollector
         ? await this.dataCollector.callStatic.getMintedERC1155s(userAddress)
-        : await this.dataCollector.methods.getMintedERC1155s(userAddress).call();
-    const items: (ExtendedMetadeta | undefined)[] = await Promise.all(
+        : await this.dataCollector.methods
+            .getMintedERC1155s(userAddress)
+            .call();
+    const items: (ExtendedMetadata | undefined)[] = await Promise.all(
       tokens.map(async (token: TokenInfo) => {
-        const metadata: PlainMetadata = (await axios.get(token.tokenURI).catch(() => undefined))?.data;
+        const metadata: PlainMetadata = (
+          await axios.get(token.tokenURI).catch(() => undefined)
+        )?.data;
         if (!metadata) return undefined;
         return {
           id: token.tokenId,
@@ -223,32 +277,56 @@ export class VWBLViewer {
     return items;
   };
 
-  getMetadataUrl = async (contractAddress: string, tokenId: number): Promise<string | undefined> => {
+  getMetadataUrl = async (
+    contractAddress: string,
+    tokenId: number
+  ): Promise<string | undefined> => {
     if (!this.dataCollector) throw new Error("please set dataCollectorAddress");
     const metadataUrl =
       "callStatic" in this.dataCollector
-        ? await this.dataCollector.callStatic.getTokenURI(contractAddress, tokenId)
-        : await this.dataCollector.methods.getTokenURI(contractAddress, tokenId).call();
+        ? await this.dataCollector.callStatic.getTokenURI(
+            contractAddress,
+            tokenId
+          )
+        : await this.dataCollector.methods
+            .getTokenURI(contractAddress, tokenId)
+            .call();
     if (!metadataUrl) return undefined;
     return metadataUrl;
   };
 
-  getDocumentId = async (contractAddress: string, tokenId: number): Promise<string | undefined> => {
+  getDocumentId = async (
+    contractAddress: string,
+    tokenId: number
+  ): Promise<string | undefined> => {
     if (!this.dataCollector) throw new Error("please set dataCollectorAddress");
     const documentId =
       "callStatic" in this.dataCollector
-        ? await this.dataCollector.callStatic.getDocumentId(contractAddress, tokenId)
-        : await this.dataCollector.methods.getDocumentId(contractAddress, tokenId).call();
+        ? await this.dataCollector.callStatic.getDocumentId(
+            contractAddress,
+            tokenId
+          )
+        : await this.dataCollector.methods
+            .getDocumentId(contractAddress, tokenId)
+            .call();
     if (!documentId) return undefined;
     return documentId;
   };
 
-  getNFTOwner = async (contractAddress: string, tokenId: number): Promise<string> => {
+  getNFTOwner = async (
+    contractAddress: string,
+    tokenId: number
+  ): Promise<string> => {
     if (!this.dataCollector) throw new Error("please set dataCollectorAddress");
     const owner =
       "callStatic" in this.dataCollector
-        ? await this.dataCollector.callStatic.getNFTOwner(contractAddress, tokenId)
-        : await this.dataCollector.methods.getNFTOwner(contractAddress, tokenId).call();
+        ? await this.dataCollector.callStatic.getNFTOwner(
+            contractAddress,
+            tokenId
+          )
+        : await this.dataCollector.methods
+            .getNFTOwner(contractAddress, tokenId)
+            .call();
     return owner;
   };
 }

packages/xrpl/.gitignore

@@ -0,0 +1,6 @@
+node_modules
+.idea
+dist
+.DS_Store
+
+*.env