ordinalsbot - npm Package Compare versions

Comparing version 0.2.0 to 0.2.1

dist/types/v1.d.ts

@@ -73,3 +73,3 @@ export interface InscriptionTransaction {
     zeroConf: string | null;
-    state: string;
+    state: InscriptionOrderState;
     createdAt: number;
@@ -187,7 +187,19 @@ paid?: boolean;
     status: string;
-    state: string;
+    state: InscriptionOrderState;
     createdAt: number;
 }
-export interface InscriptionTextOrderRequest extends InscriptionOrderRequest {
+export interface InscriptionTextOrderRequest {
     texts: string[];
+    fee?: number;
+    lowPostage?: boolean;
+    receiveAddress?: string | string[];
+    rareSats?: string;
+    referral?: string;
+    additionalFee?: number;
+    timeout?: number;
+    webhookUrl?: string;
+    compress?: boolean;
+    parent?: InscriptionOrderParentRequest;
+    projectTag?: string;
+    batchMode?: string;
 }
@@ -249,3 +261,16 @@ type InscriptionInventoryData = {
 }
+export declare enum InscriptionOrderState {
+    WAITING_PAYMENT = "waiting-payment",
+    WAITING_CONFIRMATION = "waiting-confirmation",
+    WAITING_PARENT = "waiting-parent",
+    PREP = "prep",
+    QUEUED = "queued",
+    ERROR = "error",
+    CANCELED = "cancelled",
+    WAITING_REFUND = "waiting-refund",
+    REFUNDED = "refunded",
+    EXPIRED = "expired",
+    COMPLETED = "completed"
+}
 export {};
 //# sourceMappingURL=v1.d.ts.map

dist/types/v1.js

 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
+exports.InscriptionOrderState = void 0;
+var InscriptionOrderState;
+(function (InscriptionOrderState) {
+    InscriptionOrderState["WAITING_PAYMENT"] = "waiting-payment";
+    InscriptionOrderState["WAITING_CONFIRMATION"] = "waiting-confirmation";
+    InscriptionOrderState["WAITING_PARENT"] = "waiting-parent";
+    InscriptionOrderState["PREP"] = "prep";
+    InscriptionOrderState["QUEUED"] = "queued";
+    InscriptionOrderState["ERROR"] = "error";
+    InscriptionOrderState["CANCELED"] = "cancelled";
+    InscriptionOrderState["WAITING_REFUND"] = "waiting-refund";
+    InscriptionOrderState["REFUNDED"] = "refunded";
+    InscriptionOrderState["EXPIRED"] = "expired";
+    InscriptionOrderState["COMPLETED"] = "completed";
+})(InscriptionOrderState = exports.InscriptionOrderState || (exports.InscriptionOrderState = {}));
 //# sourceMappingURL=v1.js.map

package.json

 {
   "name": "ordinalsbot",
-  "version": "0.2.0",
+  "version": "0.2.1",
   "description": "Node.js library for OrdinalsBot API",
@@ -5,0 +5,0 @@ "main": "dist/index.js",

README.md

@@ -147,2 +147,5 @@ # OrdinalsBot Node.js Library
 
-```
+```
+
+## Testing
+`npm run test`

src/types/v1.ts

@@ -175,3 +175,3 @@ export interface InscriptionTransaction {
   zeroConf: string | null;
-  state: string;
+  state: InscriptionOrderState;
   createdAt: number; // timestamp in ms,
@@ -411,3 +411,3 @@
   status: string;
-  state: string;
+  state: InscriptionOrderState;
   createdAt: number; // timestamp in ms,
@@ -418,6 +418,5 @@ }
  * Create textorder request object
+ * Does not use files, but instead uses an array of strings to be inscribed.
  */
-export interface InscriptionTextOrderRequest extends InscriptionOrderRequest {
-  // ... input parameters from InscriptionOrderRequest
-
+export interface InscriptionTextOrderRequest {
   /**
@@ -427,2 +426,66 @@ * An array of strings to be inscribed
   texts: string[];
+
+  /**
+   * Miner fee that will be paid while inscribing the ordinals in sats/byte.
+   * (default=2 sats/byte)
+   */
+  fee?: number;
+
+  /**
+   * Inscribe file with minimum postage (padding) 546 sats instead of the standard 10,000 sats.
+   * (default=false)
+   */
+  lowPostage?: boolean;
+
+  /**
+   * A single Bitcoin address to receive the inscriptions for the whole order
+   * Or one receiver Address per file
+   */
+  receiveAddress?: string | string[];
+
+  /**
+   * Inscribe on a rare, exotic, early sat.
+   * Options: vintage | block78 | pizza | uncommon | random (default=random)
+   * full list can be queried from inventory endpoint
+   */
+  rareSats?: string;
+
+  /**
+   * Referral code to earn up to %15 of the order service fee.
+   */
+  referral?: string;
+
+  /**
+   * Amount of satoshis to charge extra for this order that will be added to "referral" account.
+   * Needs to be used together with "referral" parameter.
+   */
+  additionalFee?: number;
+
+  /* Order timeout in minutes. 
+    Generated payment invoice will be valid for this duration only. Payments that are sent after this will not be processed.
+    default=4320 (3 days)
+  */
+  timeout?: number;
+
+  /** URL to receive a POST request when each file in the order is inscribed */
+  webhookUrl?: string;
+
+  /**
+   * Use brotli compression to reduce file sizes on chain
+   * default=false
+   */
+  compress?: boolean;
+
+  /**
+   *
+   */
+  parent?: InscriptionOrderParentRequest;
+
+  /**
+   *
+   */
+  projectTag?: string;
+
+  batchMode?: string;
+  
 }
@@ -519,1 +582,16 @@
 }
+
+// Order states enum
+export enum InscriptionOrderState {
+  WAITING_PAYMENT = 'waiting-payment', // order is waiting for a payment to be detected
+  WAITING_CONFIRMATION = 'waiting-confirmation', // payment is detected, waiting for confirmations
+  WAITING_PARENT = 'waiting-parent', // order is waiting for the parent inscription to hit the wallet
+  PREP = 'prep', // order files are being downloaded
+  QUEUED = 'queued', // order is queued for inscription
+  ERROR = 'error', // order has an error
+  CANCELED = 'cancelled', // order is cancelled
+  WAITING_REFUND = 'waiting-refund', // collection order is waiting refund
+  REFUNDED = 'refunded', // collection order was refunded
+  EXPIRED = 'expired', // payment processor invoice expired
+  COMPLETED = 'completed', // order is completed, files are inscribed
+}

New alerts

License Policy Violation

License

This package is not allowed per your license policy. Review the package's license to ensure compliance.

Found 1 instance in 1 package

Fixed alerts

License Policy Violation

License

This package is not allowed per your license policy. Review the package's license to ensure compliance.

Found 1 instance in 1 package

Improved metrics

Total package byte prevSize

273761

increased by1.83%

Lines of code

5392

increased by1.97%

Number of lines in readme file

151

increased by2.72%

No dependency changes