@niftykit/redeemable 0.0.1

package/README.md

@@ -0,0 +1,21 @@
+# Redeemable SDK
+
+NiiftyKit Redeemable SDK Library.
+
+## Installation
+
+1. Install via npm or yarn
+
+```bash
+# with npm
+npm install @niftykit/redeemable
+
+# with yarn
+yarn add @niftykit/redeemable
+```
+
+2. Import via CDN
+
+```html
+<script async src='https://unpkg.com/@niftykit/redeemable/dist/umd/index.js'></script>
+```

package/dist/cjs/src/Redeemable.js

@@ -0,0 +1,138 @@
+"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 (_) 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 };
+    }
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+var typechain_1 = require("@niftykit/contracts/typechain");
+var Redeemable = /** @class */ (function () {
+    function Redeemable() {
+        this.contract = {};
+    }
+    Redeemable.prototype.init = function (signerOrProvider, contractAddress) {
+        return __awaiter(this, void 0, void 0, function () {
+            return __generator(this, function (_a) {
+                this.contract = typechain_1.TokenCollection__factory.connect(contractAddress, signerOrProvider);
+                if (!this.contract) {
+                    throw new Error('Initialization failed.');
+                }
+                return [2 /*return*/];
+            });
+        });
+    };
+    Redeemable.create = function (signerOrProvider, contractAddress) {
+        return __awaiter(this, void 0, void 0, function () {
+            var instance;
+            return __generator(this, function (_a) {
+                switch (_a.label) {
+                    case 0:
+                        instance = new Redeemable();
+                        return [4 /*yield*/, instance.init(signerOrProvider, contractAddress)];
+                    case 1:
+                        _a.sent();
+                        return [2 /*return*/, instance];
+                }
+            });
+        });
+    };
+    Redeemable.prototype.getNFT = 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)];
+                    case 1:
+                        payload = _a.sent();
+                        return [2 /*return*/, {
+                                index: tokenId,
+                                tokenURI: payload.uri,
+                                price: payload.price,
+                                maxAmount: payload.maxAmount.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.getNFT(tokenId)];
+                    case 1:
+                        nft = _a.sent();
+                        return [4 /*yield*/, this.contract['redeem(uint256,uint256,bytes)'](nft.index, quantity, signature, {
+                                value: nft.price.mul(quantity),
+                            })];
+                    case 2: 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.getNFT(tokenId)];
+                    case 1:
+                        nft = _a.sent();
+                        return [4 /*yield*/, this.contract['redeem(uint256,uint256,bytes,bytes32[])'](nft.index, quantity, signature, proof, {
+                                value: nft.price.mul(quantity),
+                            })];
+                    case 2: return [2 /*return*/, _a.sent()];
+                }
+            });
+        });
+    };
+    Redeemable.prototype.burn = function (tokenId) {
+        return __awaiter(this, void 0, void 0, function () {
+            return __generator(this, function (_a) {
+                switch (_a.label) {
+                    case 0: return [4 /*yield*/, this.contract.burn(tokenId)];
+                    case 1: return [2 /*return*/, _a.sent()];
+                }
+            });
+        });
+    };
+    return Redeemable;
+}());
+exports.default = Redeemable;

package/dist/cjs/src/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/redeemable.js

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

package/dist/esm/src/Redeemable.js

@@ -0,0 +1,136 @@
+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 (_) 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__factory, } from '@niftykit/contracts/typechain';
+var Redeemable = /** @class */ (function () {
+    function Redeemable() {
+        this.contract = {};
+    }
+    Redeemable.prototype.init = function (signerOrProvider, contractAddress) {
+        return __awaiter(this, void 0, void 0, function () {
+            return __generator(this, function (_a) {
+                this.contract = TokenCollection__factory.connect(contractAddress, signerOrProvider);
+                if (!this.contract) {
+                    throw new Error('Initialization failed.');
+                }
+                return [2 /*return*/];
+            });
+        });
+    };
+    Redeemable.create = function (signerOrProvider, contractAddress) {
+        return __awaiter(this, void 0, void 0, function () {
+            var instance;
+            return __generator(this, function (_a) {
+                switch (_a.label) {
+                    case 0:
+                        instance = new Redeemable();
+                        return [4 /*yield*/, instance.init(signerOrProvider, contractAddress)];
+                    case 1:
+                        _a.sent();
+                        return [2 /*return*/, instance];
+                }
+            });
+        });
+    };
+    Redeemable.prototype.getNFT = 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)];
+                    case 1:
+                        payload = _a.sent();
+                        return [2 /*return*/, {
+                                index: tokenId,
+                                tokenURI: payload.uri,
+                                price: payload.price,
+                                maxAmount: payload.maxAmount.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.getNFT(tokenId)];
+                    case 1:
+                        nft = _a.sent();
+                        return [4 /*yield*/, this.contract['redeem(uint256,uint256,bytes)'](nft.index, quantity, signature, {
+                                value: nft.price.mul(quantity),
+                            })];
+                    case 2: 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.getNFT(tokenId)];
+                    case 1:
+                        nft = _a.sent();
+                        return [4 /*yield*/, this.contract['redeem(uint256,uint256,bytes,bytes32[])'](nft.index, quantity, signature, proof, {
+                                value: nft.price.mul(quantity),
+                            })];
+                    case 2: return [2 /*return*/, _a.sent()];
+                }
+            });
+        });
+    };
+    Redeemable.prototype.burn = function (tokenId) {
+        return __awaiter(this, void 0, void 0, function () {
+            return __generator(this, function (_a) {
+                switch (_a.label) {
+                    case 0: return [4 /*yield*/, this.contract.burn(tokenId)];
+                    case 1: return [2 /*return*/, _a.sent()];
+                }
+            });
+        });
+    };
+    return Redeemable;
+}());
+export default Redeemable;

package/dist/esm/src/index.js

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

package/dist/esm/types/redeemable.js

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

package/dist/types/src/Redeemable.d.ts

@@ -0,0 +1,13 @@
+import { Provider } from '@ethersproject/providers';
+import { TokenCollection } from '@niftykit/contracts/typechain';
+import { ContractTransaction, Signer } from 'ethers';
+import { RedeemableData } from '../types/redeemable';
+export default class Redeemable {
+    contract: TokenCollection;
+    private init;
+    static create(signerOrProvider: Signer | Provider, contractAddress: string): Promise<Redeemable | null>;
+    getNFT(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/src/index.d.ts

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

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;
+}