@niftykit/redeemable 0.0.11 → 0.1.1

package/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2022 NiftyKit Inc. (niftykit.com)
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

package/dist/cjs/Redeemable.js

@@ -0,0 +1,185 @@
+"use strict";
+var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, generator) {
+    function adopt(value) { return value instanceof P ? value : new P(function (resolve) { resolve(value); }); }
+    return new (P || (P = Promise))(function (resolve, reject) {
+        function fulfilled(value) { try { step(generator.next(value)); } catch (e) { reject(e); } }
+        function rejected(value) { try { step(generator["throw"](value)); } catch (e) { reject(e); } }
+        function step(result) { result.done ? resolve(result.value) : adopt(result.value).then(fulfilled, rejected); }
+        step((generator = generator.apply(thisArg, _arguments || [])).next());
+    });
+};
+var __generator = (this && this.__generator) || function (thisArg, body) {
+    var _ = { label: 0, sent: function() { if (t[0] & 1) throw t[1]; return t[1]; }, trys: [], ops: [] }, f, y, t, g;
+    return g = { next: verb(0), "throw": verb(1), "return": verb(2) }, typeof Symbol === "function" && (g[Symbol.iterator] = function() { return this; }), g;
+    function verb(n) { return function (v) { return step([n, v]); }; }
+    function step(op) {
+        if (f) throw new TypeError("Generator is already executing.");
+        while (g && (g = 0, op[0] && (_ = 0)), _) try {
+            if (f = 1, y && (t = op[0] & 2 ? y["return"] : op[0] ? y["throw"] || ((t = y["return"]) && t.call(y), 0) : y.next) && !(t = t.call(y, op[1])).done) return t;
+            if (y = 0, t) op = [op[0] & 2, t.value];
+            switch (op[0]) {
+                case 0: case 1: t = op; break;
+                case 4: _.label++; return { value: op[1], done: false };
+                case 5: _.label++; y = op[1]; op = [0]; continue;
+                case 7: op = _.ops.pop(); _.trys.pop(); continue;
+                default:
+                    if (!(t = _.trys, t = t.length > 0 && t[t.length - 1]) && (op[0] === 6 || op[0] === 2)) { _ = 0; continue; }
+                    if (op[0] === 3 && (!t || (op[1] > t[0] && op[1] < t[3]))) { _.label = op[1]; break; }
+                    if (op[0] === 6 && _.label < t[1]) { _.label = t[1]; t = op; break; }
+                    if (t && _.label < t[2]) { _.label = t[2]; _.ops.push(op); break; }
+                    if (t[2]) _.ops.pop();
+                    _.trys.pop(); continue;
+            }
+            op = body.call(thisArg, _);
+        } catch (e) { op = [6, e]; y = 0; } finally { f = t = 0; }
+        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 contracts_1 = require("@niftykit/contracts");
+var axios_1 = __importDefault(require("axios"));
+var ethers_1 = require("ethers");
+var endpoint_1 = require("./config/endpoint");
+var Redeemable = /** @class */ (function () {
+    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) {
+                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
+                                ? contracts_1.TokenCollection__factoryV2.connect(contractAddress, signerOrProvider)
+                                : contracts_1.TokenCollection__factory.connect(contractAddress, signerOrProvider);
+                        if (!this.contract) {
+                            throw new Error('Initialization failed.');
+                        }
+                        return [2 /*return*/];
+                }
+            });
+        });
+    };
+    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(isDev);
+                        return [4 /*yield*/, instance.init(signerOrProvider, contractAddress)];
+                    case 1:
+                        _a.sent();
+                        return [2 /*return*/, instance];
+                }
+            });
+        });
+    };
+    Redeemable.prototype.getRedeemable = function (tokenId) {
+        return __awaiter(this, void 0, void 0, function () {
+            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.redeemableAt(tokenId)];
+                    case 1:
+                        _a = _b.sent();
+                        return [3 /*break*/, 4];
+                    case 2: return [4 /*yield*/, this.contract.redeemableByIndex(tokenId)];
+                    case 3:
+                        _a = _b.sent();
+                        _b.label = 4;
+                    case 4:
+                        payload = _a;
+                        return [2 /*return*/, {
+                                index: tokenId,
+                                tokenURI: payload[0],
+                                price: payload.price,
+                                maxAmount: payload[3].toNumber(),
+                                maxPerWallet: payload.maxPerWallet.toNumber(),
+                                maxPerMint: payload.maxPerMint.toNumber(),
+                                redeemedCount: payload.redeemedCount.toNumber(),
+                                merkleRoot: payload.merkleRoot,
+                                active: payload.active,
+                                nonce: payload.nonce,
+                            }];
+                }
+            });
+        });
+    };
+    Redeemable.prototype.redeem = function (tokenId, quantity, signature) {
+        return __awaiter(this, void 0, void 0, function () {
+            var nft;
+            return __generator(this, function (_a) {
+                switch (_a.label) {
+                    case 0: return [4 /*yield*/, this.getRedeemable(tokenId)];
+                    case 1:
+                        nft = _a.sent();
+                        if (!(this.version > 1)) return [3 /*break*/, 3];
+                        return [4 /*yield*/, this.contract.redeem(nft.index, quantity, signature, [], {
+                                value: nft.price.mul(quantity),
+                            })];
+                    case 2: return [2 /*return*/, _a.sent()];
+                    case 3: return [4 /*yield*/, this.contract['redeem(uint256,uint256,bytes)'](nft.index, quantity, signature, {
+                            value: nft.price.mul(quantity),
+                        })];
+                    case 4: return [2 /*return*/, _a.sent()];
+                }
+            });
+        });
+    };
+    Redeemable.prototype.presaleRedeem = function (tokenId, quantity, signature, proof) {
+        return __awaiter(this, void 0, void 0, function () {
+            var nft;
+            return __generator(this, function (_a) {
+                switch (_a.label) {
+                    case 0: return [4 /*yield*/, this.getRedeemable(tokenId)];
+                    case 1:
+                        nft = _a.sent();
+                        if (!(this.version > 1)) return [3 /*break*/, 3];
+                        return [4 /*yield*/, this.contract.redeem(nft.index, quantity, signature, proof, {
+                                value: nft.price.mul(quantity),
+                            })];
+                    case 2: return [2 /*return*/, _a.sent()];
+                    case 3: return [4 /*yield*/, this.contract['redeem(uint256,uint256,bytes,bytes32[])'](nft.index, quantity, signature, proof, {
+                            value: nft.price.mul(quantity),
+                        })];
+                    case 4: return [2 /*return*/, _a.sent()];
+                }
+            });
+        });
+    };
+    Redeemable.prototype.burn = function (tokenId) {
+        return this.contract.burn(tokenId);
+    };
+    return Redeemable;
+}());
+exports.default = Redeemable;

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/index.js

@@ -0,0 +1,7 @@
+"use strict";
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+var Redeemable_1 = __importDefault(require("./Redeemable"));
+exports.default = Redeemable_1.default;

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

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

package/dist/cjs/types/redeemable.js

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

package/dist/esm/Redeemable.js

@@ -0,0 +1,180 @@
+var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, generator) {
+    function adopt(value) { return value instanceof P ? value : new P(function (resolve) { resolve(value); }); }
+    return new (P || (P = Promise))(function (resolve, reject) {
+        function fulfilled(value) { try { step(generator.next(value)); } catch (e) { reject(e); } }
+        function rejected(value) { try { step(generator["throw"](value)); } catch (e) { reject(e); } }
+        function step(result) { result.done ? resolve(result.value) : adopt(result.value).then(fulfilled, rejected); }
+        step((generator = generator.apply(thisArg, _arguments || [])).next());
+    });
+};
+var __generator = (this && this.__generator) || function (thisArg, body) {
+    var _ = { label: 0, sent: function() { if (t[0] & 1) throw t[1]; return t[1]; }, trys: [], ops: [] }, f, y, t, g;
+    return g = { next: verb(0), "throw": verb(1), "return": verb(2) }, typeof Symbol === "function" && (g[Symbol.iterator] = function() { return this; }), g;
+    function verb(n) { return function (v) { return step([n, v]); }; }
+    function step(op) {
+        if (f) throw new TypeError("Generator is already executing.");
+        while (g && (g = 0, op[0] && (_ = 0)), _) try {
+            if (f = 1, y && (t = op[0] & 2 ? y["return"] : op[0] ? y["throw"] || ((t = y["return"]) && t.call(y), 0) : y.next) && !(t = t.call(y, op[1])).done) return t;
+            if (y = 0, t) op = [op[0] & 2, t.value];
+            switch (op[0]) {
+                case 0: case 1: t = op; break;
+                case 4: _.label++; return { value: op[1], done: false };
+                case 5: _.label++; y = op[1]; op = [0]; continue;
+                case 7: op = _.ops.pop(); _.trys.pop(); continue;
+                default:
+                    if (!(t = _.trys, t = t.length > 0 && t[t.length - 1]) && (op[0] === 6 || op[0] === 2)) { _ = 0; continue; }
+                    if (op[0] === 3 && (!t || (op[1] > t[0] && op[1] < t[3]))) { _.label = op[1]; break; }
+                    if (op[0] === 6 && _.label < t[1]) { _.label = t[1]; t = op; break; }
+                    if (t && _.label < t[2]) { _.label = t[2]; _.ops.push(op); break; }
+                    if (t[2]) _.ops.pop();
+                    _.trys.pop(); continue;
+            }
+            op = body.call(thisArg, _);
+        } catch (e) { op = [6, e]; y = 0; } finally { f = t = 0; }
+        if (op[0] & 5) throw op[1]; return { value: op[0] ? op[1] : void 0, done: true };
+    }
+};
+import { TokenCollection__factoryV2, TokenCollection__factory, } from '@niftykit/contracts';
+import axios from 'axios';
+import { ethers } from 'ethers';
+import { API_ENDPOINT, API_ENDPOINT_DEV } from './config/endpoint';
+var Redeemable = /** @class */ (function () {
+    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) {
+                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__factoryV2.connect(contractAddress, signerOrProvider)
+                                : TokenCollection__factory.connect(contractAddress, signerOrProvider);
+                        if (!this.contract) {
+                            throw new Error('Initialization failed.');
+                        }
+                        return [2 /*return*/];
+                }
+            });
+        });
+    };
+    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(isDev);
+                        return [4 /*yield*/, instance.init(signerOrProvider, contractAddress)];
+                    case 1:
+                        _a.sent();
+                        return [2 /*return*/, instance];
+                }
+            });
+        });
+    };
+    Redeemable.prototype.getRedeemable = function (tokenId) {
+        return __awaiter(this, void 0, void 0, function () {
+            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.redeemableAt(tokenId)];
+                    case 1:
+                        _a = _b.sent();
+                        return [3 /*break*/, 4];
+                    case 2: return [4 /*yield*/, this.contract.redeemableByIndex(tokenId)];
+                    case 3:
+                        _a = _b.sent();
+                        _b.label = 4;
+                    case 4:
+                        payload = _a;
+                        return [2 /*return*/, {
+                                index: tokenId,
+                                tokenURI: payload[0],
+                                price: payload.price,
+                                maxAmount: payload[3].toNumber(),
+                                maxPerWallet: payload.maxPerWallet.toNumber(),
+                                maxPerMint: payload.maxPerMint.toNumber(),
+                                redeemedCount: payload.redeemedCount.toNumber(),
+                                merkleRoot: payload.merkleRoot,
+                                active: payload.active,
+                                nonce: payload.nonce,
+                            }];
+                }
+            });
+        });
+    };
+    Redeemable.prototype.redeem = function (tokenId, quantity, signature) {
+        return __awaiter(this, void 0, void 0, function () {
+            var nft;
+            return __generator(this, function (_a) {
+                switch (_a.label) {
+                    case 0: return [4 /*yield*/, this.getRedeemable(tokenId)];
+                    case 1:
+                        nft = _a.sent();
+                        if (!(this.version > 1)) return [3 /*break*/, 3];
+                        return [4 /*yield*/, this.contract.redeem(nft.index, quantity, signature, [], {
+                                value: nft.price.mul(quantity),
+                            })];
+                    case 2: return [2 /*return*/, _a.sent()];
+                    case 3: return [4 /*yield*/, this.contract['redeem(uint256,uint256,bytes)'](nft.index, quantity, signature, {
+                            value: nft.price.mul(quantity),
+                        })];
+                    case 4: return [2 /*return*/, _a.sent()];
+                }
+            });
+        });
+    };
+    Redeemable.prototype.presaleRedeem = function (tokenId, quantity, signature, proof) {
+        return __awaiter(this, void 0, void 0, function () {
+            var nft;
+            return __generator(this, function (_a) {
+                switch (_a.label) {
+                    case 0: return [4 /*yield*/, this.getRedeemable(tokenId)];
+                    case 1:
+                        nft = _a.sent();
+                        if (!(this.version > 1)) return [3 /*break*/, 3];
+                        return [4 /*yield*/, this.contract.redeem(nft.index, quantity, signature, proof, {
+                                value: nft.price.mul(quantity),
+                            })];
+                    case 2: return [2 /*return*/, _a.sent()];
+                    case 3: return [4 /*yield*/, this.contract['redeem(uint256,uint256,bytes,bytes32[])'](nft.index, quantity, signature, proof, {
+                            value: nft.price.mul(quantity),
+                        })];
+                    case 4: return [2 /*return*/, _a.sent()];
+                }
+            });
+        });
+    };
+    Redeemable.prototype.burn = function (tokenId) {
+        return this.contract.burn(tokenId);
+    };
+    return Redeemable;
+}());
+export default Redeemable;

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/index.js

@@ -0,0 +1,2 @@
+import Redeemable from './Redeemable';
+export default Redeemable;

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

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

package/dist/esm/types/redeemable.js

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

package/dist/types/Redeemable.d.ts

@@ -0,0 +1,17 @@
+import { Provider } from '@ethersproject/providers';
+import { TokenCollection, TokenCollectionV2 } from '@niftykit/contracts';
+import { ContractTransaction, Signer } from 'ethers';
+import { RedeemableData } from './types/redeemable';
+export default class Redeemable {
+    contract: TokenCollection | TokenCollectionV2;
+    isDev?: boolean;
+    version: number;
+    private get apiBaseUrl();
+    constructor(isDev?: boolean);
+    private init;
+    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/index.d.ts

@@ -0,0 +1,2 @@
+import Redeemable from './Redeemable';
+export default Redeemable;

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

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

package/dist/types/types/redeemable.d.ts

@@ -0,0 +1,13 @@
+import { ethers } from 'ethers';
+export interface RedeemableData {
+    index: number;
+    tokenURI: string;
+    price: ethers.BigNumber;
+    maxAmount: number;
+    maxPerWallet: number;
+    maxPerMint: number;
+    redeemedCount: number;
+    merkleRoot: string;
+    active: boolean;
+    nonce: ethers.BigNumber;
+}