@niftykit/redeemable 0.0.2 → 0.0.6

package/README.md

@@ -1,10 +1,10 @@
 # Redeemable SDK
 
-NiiftyKit Redeemable SDK Library.
+NiftyKit Redeemable SDK Library.
 
 ## Installation
 
-1. Install via npm or yarn
+Install via npm or yarn
 
 ```bash
 # with npm
@@ -14,7 +14,7 @@ npm install @niftykit/redeemable
 yarn add @niftykit/redeemable
 ```
 
-2. Import via CDN
+Or use it via CDN
 
 ```html
 <script async src='https://unpkg.com/@niftykit/redeemable/dist/umd/index.js'></script>
@@ -30,13 +30,18 @@ Example URL:
 https://app.niftykit.com/collections/your-collection/redeemables/1/0x5f635ae4051272d477a6ebbcdfd32d2d55a300004512c01873315194d853f15b29087799de88530240a0a0f17f5e9f8d6881b4b248ebc83c06ce7c33b9ef01971b
 ```
 
-In this case the `tokenId` is `1` and the signature is `0x5f635ae4051272d477a6ebbcdfd32d2d55a300004512c01873315194d853f15b29087799de88530240a0a0f17f5e9f8d6881b4b248ebc83c06ce7c33b9ef01971b`.
+In this case the `tokenId` is `1` and the signature is
+
+```bash
+0x5f635ae4051272d477a6ebbcdfd32d2d55a300004512c01873315194d853f15b29087799de88530240a0a0f17f5e9f8d6881b4b248ebc83c06ce7c33b9ef01971b
+```
 
 > Note: if you re-generate your redeemable link, you will get a new `signature` and need to update your code.
 
 ```typescript
 // using ethers.js
 import { ethers } from 'ethers';
+import Redeemable from '@niftykit/redeemable';
 
 const provider = new ethers.providers.Web3Provider(window.ethereum, 'any');
 await provider.send('eth_requestAccounts', []);

package/dist/cjs/{src/Redeemable.js → Redeemable.js}

@@ -35,30 +35,65 @@ var __generator = (this && this.__generator) || function (thisArg, body) {
         if (op[0] & 5) throw op[1]; return { value: op[0] ? op[1] : void 0, done: true };
     }
 };
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
 Object.defineProperty(exports, "__esModule", { value: true });
 var typechain_1 = require("@niftykit/contracts/typechain");
+var axios_1 = __importDefault(require("axios"));
+var ethers_1 = require("ethers");
+var endpoint_1 = require("./config/endpoint");
 var Redeemable = /** @class */ (function () {
-    function Redeemable() {
+    function Redeemable(isDev) {
         this.contract = {};
+        this.version = 1;
+        this.isDev = isDev;
     }
+    Object.defineProperty(Redeemable.prototype, "apiBaseUrl", {
+        get: function () {
+            return this.isDev ? endpoint_1.API_ENDPOINT_DEV : endpoint_1.API_ENDPOINT;
+        },
+        enumerable: false,
+        configurable: true
+    });
     Redeemable.prototype.init = function (signerOrProvider, contractAddress) {
         return __awaiter(this, void 0, void 0, function () {
+            var url, resp;
             return __generator(this, function (_a) {
-                this.contract = typechain_1.TokenCollection__factory.connect(contractAddress, signerOrProvider);
-                if (!this.contract) {
-                    throw new Error('Initialization failed.');
+                switch (_a.label) {
+                    case 0:
+                        if (!ethers_1.ethers.utils.isAddress(contractAddress)) {
+                            throw new Error('Invalid contract address.');
+                        }
+                        url = "".concat(this.apiBaseUrl, "/v2/redeemables/").concat(contractAddress);
+                        return [4 /*yield*/, axios_1.default.get(url, {
+                                validateStatus: function (status) { return status < 500; },
+                            })];
+                    case 1:
+                        resp = _a.sent();
+                        if (resp.status !== 200) {
+                            throw new Error('Something went wrong.');
+                        }
+                        this.version = resp.data.version;
+                        this.contract =
+                            this.version === 1
+                                ? typechain_1.TokenCollection__factory.connect(contractAddress, signerOrProvider)
+                                : typechain_1.TokenCollection__factoryV2.connect(contractAddress, signerOrProvider);
+                        if (!this.contract) {
+                            throw new Error('Initialization failed.');
+                        }
+                        return [2 /*return*/];
                 }
-                return [2 /*return*/];
             });
         });
     };
-    Redeemable.create = function (signerOrProvider, contractAddress) {
+    Redeemable.create = function (signerOrProvider, contractAddress, isDev) {
         return __awaiter(this, void 0, void 0, function () {
             var instance;
             return __generator(this, function (_a) {
                 switch (_a.label) {
                     case 0:
-                        instance = new Redeemable();
+                        instance = new Redeemable(isDev);
                         return [4 /*yield*/, instance.init(signerOrProvider, contractAddress)];
                     case 1:
                         _a.sent();
@@ -67,19 +102,28 @@ var Redeemable = /** @class */ (function () {
             });
         });
     };
-    Redeemable.prototype.getNFT = function (tokenId) {
+    Redeemable.prototype.getRedeemable = function (tokenId) {
         return __awaiter(this, void 0, void 0, function () {
-            var payload;
-            return __generator(this, function (_a) {
-                switch (_a.label) {
-                    case 0: return [4 /*yield*/, this.contract.redeemableByIndex(tokenId)];
+            var payload, _a;
+            return __generator(this, function (_b) {
+                switch (_b.label) {
+                    case 0:
+                        if (!(this.version === 1)) return [3 /*break*/, 2];
+                        return [4 /*yield*/, this.contract.redeemableByIndex(tokenId)];
                     case 1:
-                        payload = _a.sent();
+                        _a = _b.sent();
+                        return [3 /*break*/, 4];
+                    case 2: return [4 /*yield*/, this.contract.redeemableAt(tokenId)];
+                    case 3:
+                        _a = _b.sent();
+                        _b.label = 4;
+                    case 4:
+                        payload = _a;
                         return [2 /*return*/, {
                                 index: tokenId,
-                                tokenURI: payload.uri,
+                                tokenURI: payload[0],
                                 price: payload.price,
-                                maxAmount: payload.maxAmount.toNumber(),
+                                maxAmount: payload[3].toNumber(),
                                 maxPerWallet: payload.maxPerWallet.toNumber(),
                                 maxPerMint: payload.maxPerMint.toNumber(),
                                 redeemedCount: payload.redeemedCount.toNumber(),
@@ -96,7 +140,7 @@ var Redeemable = /** @class */ (function () {
             var nft;
             return __generator(this, function (_a) {
                 switch (_a.label) {
-                    case 0: return [4 /*yield*/, this.getNFT(tokenId)];
+                    case 0: return [4 /*yield*/, this.getRedeemable(tokenId)];
                     case 1:
                         nft = _a.sent();
                         return [4 /*yield*/, this.contract['redeem(uint256,uint256,bytes)'](nft.index, quantity, signature, {
@@ -112,7 +156,7 @@ var Redeemable = /** @class */ (function () {
             var nft;
             return __generator(this, function (_a) {
                 switch (_a.label) {
-                    case 0: return [4 /*yield*/, this.getNFT(tokenId)];
+                    case 0: return [4 /*yield*/, this.getRedeemable(tokenId)];
                     case 1:
                         nft = _a.sent();
                         return [4 /*yield*/, this.contract['redeem(uint256,uint256,bytes,bytes32[])'](nft.index, quantity, signature, proof, {

package/dist/cjs/config/endpoint.js

@@ -0,0 +1,5 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.API_ENDPOINT = exports.API_ENDPOINT_DEV = void 0;
+exports.API_ENDPOINT_DEV = 'https://api-testnet.niftykit.com';
+exports.API_ENDPOINT = 'https://api.niftykit.com';

package/dist/cjs/types/api-responses.js

@@ -0,0 +1,2 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });

package/dist/esm/{src/Redeemable.js → Redeemable.js}

@@ -34,29 +34,61 @@ var __generator = (this && this.__generator) || function (thisArg, body) {
         if (op[0] & 5) throw op[1]; return { value: op[0] ? op[1] : void 0, done: true };
     }
 };
-import { TokenCollection__factory, } from '@niftykit/contracts/typechain';
+import { TokenCollection__factoryV2, TokenCollection__factory, } from '@niftykit/contracts/typechain';
+import axios from 'axios';
+import { ethers } from 'ethers';
+import { API_ENDPOINT, API_ENDPOINT_DEV } from './config/endpoint';
 var Redeemable = /** @class */ (function () {
-    function Redeemable() {
+    function Redeemable(isDev) {
         this.contract = {};
+        this.version = 1;
+        this.isDev = isDev;
     }
+    Object.defineProperty(Redeemable.prototype, "apiBaseUrl", {
+        get: function () {
+            return this.isDev ? API_ENDPOINT_DEV : API_ENDPOINT;
+        },
+        enumerable: false,
+        configurable: true
+    });
     Redeemable.prototype.init = function (signerOrProvider, contractAddress) {
         return __awaiter(this, void 0, void 0, function () {
+            var url, resp;
             return __generator(this, function (_a) {
-                this.contract = TokenCollection__factory.connect(contractAddress, signerOrProvider);
-                if (!this.contract) {
-                    throw new Error('Initialization failed.');
+                switch (_a.label) {
+                    case 0:
+                        if (!ethers.utils.isAddress(contractAddress)) {
+                            throw new Error('Invalid contract address.');
+                        }
+                        url = "".concat(this.apiBaseUrl, "/v2/redeemables/").concat(contractAddress);
+                        return [4 /*yield*/, axios.get(url, {
+                                validateStatus: function (status) { return status < 500; },
+                            })];
+                    case 1:
+                        resp = _a.sent();
+                        if (resp.status !== 200) {
+                            throw new Error('Something went wrong.');
+                        }
+                        this.version = resp.data.version;
+                        this.contract =
+                            this.version === 1
+                                ? TokenCollection__factory.connect(contractAddress, signerOrProvider)
+                                : TokenCollection__factoryV2.connect(contractAddress, signerOrProvider);
+                        if (!this.contract) {
+                            throw new Error('Initialization failed.');
+                        }
+                        return [2 /*return*/];
                 }
-                return [2 /*return*/];
             });
         });
     };
-    Redeemable.create = function (signerOrProvider, contractAddress) {
+    Redeemable.create = function (signerOrProvider, contractAddress, isDev) {
         return __awaiter(this, void 0, void 0, function () {
             var instance;
             return __generator(this, function (_a) {
                 switch (_a.label) {
                     case 0:
-                        instance = new Redeemable();
+                        instance = new Redeemable(isDev);
                         return [4 /*yield*/, instance.init(signerOrProvider, contractAddress)];
                     case 1:
                         _a.sent();
@@ -65,19 +97,28 @@ var Redeemable = /** @class */ (function () {
             });
         });
     };
-    Redeemable.prototype.getNFT = function (tokenId) {
+    Redeemable.prototype.getRedeemable = function (tokenId) {
         return __awaiter(this, void 0, void 0, function () {
-            var payload;
-            return __generator(this, function (_a) {
-                switch (_a.label) {
-                    case 0: return [4 /*yield*/, this.contract.redeemableByIndex(tokenId)];
+            var payload, _a;
+            return __generator(this, function (_b) {
+                switch (_b.label) {
+                    case 0:
+                        if (!(this.version === 1)) return [3 /*break*/, 2];
+                        return [4 /*yield*/, this.contract.redeemableByIndex(tokenId)];
                     case 1:
-                        payload = _a.sent();
+                        _a = _b.sent();
+                        return [3 /*break*/, 4];
+                    case 2: return [4 /*yield*/, this.contract.redeemableAt(tokenId)];
+                    case 3:
+                        _a = _b.sent();
+                        _b.label = 4;
+                    case 4:
+                        payload = _a;
                         return [2 /*return*/, {
                                 index: tokenId,
-                                tokenURI: payload.uri,
+                                tokenURI: payload[0],
                                 price: payload.price,
-                                maxAmount: payload.maxAmount.toNumber(),
+                                maxAmount: payload[3].toNumber(),
                                 maxPerWallet: payload.maxPerWallet.toNumber(),
                                 maxPerMint: payload.maxPerMint.toNumber(),
                                 redeemedCount: payload.redeemedCount.toNumber(),
@@ -94,7 +135,7 @@ var Redeemable = /** @class */ (function () {
             var nft;
             return __generator(this, function (_a) {
                 switch (_a.label) {
-                    case 0: return [4 /*yield*/, this.getNFT(tokenId)];
+                    case 0: return [4 /*yield*/, this.getRedeemable(tokenId)];
                     case 1:
                         nft = _a.sent();
                         return [4 /*yield*/, this.contract['redeem(uint256,uint256,bytes)'](nft.index, quantity, signature, {
@@ -110,7 +151,7 @@ var Redeemable = /** @class */ (function () {
             var nft;
             return __generator(this, function (_a) {
                 switch (_a.label) {
-                    case 0: return [4 /*yield*/, this.getNFT(tokenId)];
+                    case 0: return [4 /*yield*/, this.getRedeemable(tokenId)];
                     case 1:
                         nft = _a.sent();
                         return [4 /*yield*/, this.contract['redeem(uint256,uint256,bytes,bytes32[])'](nft.index, quantity, signature, proof, {

package/dist/esm/config/endpoint.js

@@ -0,0 +1,2 @@
+export var API_ENDPOINT_DEV = 'https://api-testnet.niftykit.com';
+export var API_ENDPOINT = 'https://api.niftykit.com';

package/dist/esm/types/api-responses.js

@@ -0,0 +1 @@
+export {};

package/dist/types/{src/Redeemable.d.ts → Redeemable.d.ts}

@@ -1,12 +1,16 @@
 import { Provider } from '@ethersproject/providers';
-import { TokenCollection } from '@niftykit/contracts/typechain';
+import { TokenCollection, TokenCollectionV2 } from '@niftykit/contracts/typechain';
 import { ContractTransaction, Signer } from 'ethers';
-import { RedeemableData } from '../types/redeemable';
+import { RedeemableData } from './types/redeemable';
 export default class Redeemable {
-    contract: TokenCollection;
+    contract: TokenCollection | TokenCollectionV2;
+    isDev?: boolean;
+    version: number;
+    private get apiBaseUrl();
+    constructor(isDev?: boolean);
     private init;
-    static create(signerOrProvider: Signer | Provider, contractAddress: string): Promise<Redeemable | null>;
-    getNFT(tokenId: number): Promise<RedeemableData>;
+    static create(signerOrProvider: Signer | Provider, contractAddress: string, isDev?: boolean): Promise<Redeemable | null>;
+    getRedeemable(tokenId: number): Promise<RedeemableData>;
     redeem(tokenId: number, quantity: number, signature: string): Promise<ContractTransaction>;
     presaleRedeem(tokenId: number, quantity: number, signature: string, proof: string[]): Promise<ContractTransaction>;
     burn(tokenId: number): Promise<ContractTransaction>;

package/dist/types/config/endpoint.d.ts

@@ -0,0 +1,2 @@
+export declare const API_ENDPOINT_DEV = "https://api-testnet.niftykit.com";
+export declare const API_ENDPOINT = "https://api.niftykit.com";

package/dist/types/types/api-responses.d.ts

@@ -0,0 +1,6 @@
+export declare type RedeemableApiResponse = {
+    address: string;
+    version: number;
+    chainId: number;
+    networkName: string;
+};