@atomicfinance/types 3.5.0 → 3.5.1

package/CHANGELOG.md

@@ -1,5 +1,11 @@
 # @atomicfinance/types
 
+## 3.5.1
+
+### Patch Changes
+
+- 9aa93d3: Fix types for bitcoin-rpc-provider
+
 ## 3.5.0
 
 ### Minor Changes

package/lib/address.js

@@ -0,0 +1,11 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.Address = void 0;
+class Address {
+    constructor(fields) {
+        if (fields)
+            Object.assign(this, fields);
+    }
+}
+exports.Address = Address;
+//# sourceMappingURL=address.js.map

package/lib/bitcoin.js

@@ -0,0 +1,16 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.SwapMode = exports.AddressType = void 0;
+var AddressType;
+(function (AddressType) {
+    AddressType["LEGACY"] = "legacy";
+    AddressType["P2SH_SEGWIT"] = "p2sh-segwit";
+    AddressType["BECH32"] = "bech32";
+})(AddressType = exports.AddressType || (exports.AddressType = {}));
+var SwapMode;
+(function (SwapMode) {
+    SwapMode["P2SH"] = "p2sh";
+    SwapMode["P2SH_SEGWIT"] = "p2shSegwit";
+    SwapMode["P2WSH"] = "p2wsh";
+})(SwapMode = exports.SwapMode || (exports.SwapMode = {}));
+//# sourceMappingURL=bitcoin.js.map

package/lib/block.js

@@ -0,0 +1,3 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+//# sourceMappingURL=block.js.map

package/lib/cfd.js

@@ -0,0 +1,5 @@
+"use strict";
+/* eslint-disable max-len */
+/* eslint-disable indent */
+Object.defineProperty(exports, "__esModule", { value: true });
+//# sourceMappingURL=cfd.js.map

package/lib/chain.js

@@ -0,0 +1,3 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+//# sourceMappingURL=chain.js.map

package/lib/common.js

@@ -0,0 +1,3 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+//# sourceMappingURL=common.js.map

package/lib/dlc.js

@@ -0,0 +1,5 @@
+"use strict";
+/* eslint-disable max-len */
+/* eslint-disable indent */
+Object.defineProperty(exports, "__esModule", { value: true });
+//# sourceMappingURL=dlc.js.map

package/lib/fees.js

@@ -0,0 +1,3 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+//# sourceMappingURL=fees.js.map

package/lib/index.js

@@ -0,0 +1,59 @@
+"use strict";
+var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    var desc = Object.getOwnPropertyDescriptor(m, k);
+    if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
+      desc = { enumerable: true, get: function() { return m[k]; } };
+    }
+    Object.defineProperty(o, k2, desc);
+}) : (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    o[k2] = m[k];
+}));
+var __setModuleDefault = (this && this.__setModuleDefault) || (Object.create ? (function(o, v) {
+    Object.defineProperty(o, "default", { enumerable: true, value: v });
+}) : function(o, v) {
+    o["default"] = v;
+});
+var __importStar = (this && this.__importStar) || function (mod) {
+    if (mod && mod.__esModule) return mod;
+    var result = {};
+    if (mod != null) for (var k in mod) if (k !== "default" && Object.prototype.hasOwnProperty.call(mod, k)) __createBinding(result, mod, k);
+    __setModuleDefault(result, mod);
+    return result;
+};
+var __exportStar = (this && this.__exportStar) || function(m, exports) {
+    for (var p in m) if (p !== "default" && !Object.prototype.hasOwnProperty.call(exports, p)) __createBinding(exports, m, p);
+};
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.bitcoin = exports.BitcoinJsonRpcTypes = exports.TxStatus = exports.Address = exports.BigNumber = exports.Utxo = exports.Output = exports.Outcome = exports.OracleInfo = exports.Input = exports.Amount = void 0;
+const bignumber_js_1 = __importDefault(require("bignumber.js"));
+exports.BigNumber = bignumber_js_1.default;
+const address_1 = require("./address");
+Object.defineProperty(exports, "Address", { enumerable: true, get: function () { return address_1.Address; } });
+const bitcoin = __importStar(require("./bitcoin"));
+exports.bitcoin = bitcoin;
+const BitcoinJsonRpcTypes = __importStar(require("./jsonrpc"));
+exports.BitcoinJsonRpcTypes = BitcoinJsonRpcTypes;
+const transaction_1 = require("./transaction");
+Object.defineProperty(exports, "TxStatus", { enumerable: true, get: function () { return transaction_1.TxStatus; } });
+__exportStar(require("./cfd"), exports);
+__exportStar(require("./common"), exports);
+__exportStar(require("./dlc"), exports);
+var Amount_1 = require("./models/Amount");
+Object.defineProperty(exports, "Amount", { enumerable: true, get: function () { return __importDefault(Amount_1).default; } });
+var Input_1 = require("./models/Input");
+Object.defineProperty(exports, "Input", { enumerable: true, get: function () { return __importDefault(Input_1).default; } });
+var OracleInfo_1 = require("./models/OracleInfo");
+Object.defineProperty(exports, "OracleInfo", { enumerable: true, get: function () { return __importDefault(OracleInfo_1).default; } });
+var Outcome_1 = require("./models/Outcome");
+Object.defineProperty(exports, "Outcome", { enumerable: true, get: function () { return __importDefault(Outcome_1).default; } });
+var Output_1 = require("./models/Output");
+Object.defineProperty(exports, "Output", { enumerable: true, get: function () { return __importDefault(Output_1).default; } });
+var Utxo_1 = require("./models/Utxo");
+Object.defineProperty(exports, "Utxo", { enumerable: true, get: function () { return __importDefault(Utxo_1).default; } });
+__exportStar(require("./wallet"), exports);
+//# sourceMappingURL=index.js.map

package/lib/jsonrpc.js

@@ -0,0 +1,3 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+//# sourceMappingURL=jsonrpc.js.map

package/lib/models/Amount.js

@@ -0,0 +1,65 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+// Used to convert between satoshi and bitcoin.
+const ConversionFactor = 100000000;
+class Amount {
+    constructor(satoshis) {
+        this._satoshis = satoshis;
+        this.toJSON = Amount.prototype.toJSON;
+        this.GetSatoshiAmount = Amount.prototype.GetSatoshiAmount;
+    }
+    // Create an Amount object using bitcoin unit.
+    static FromBitcoin(bitcoin) {
+        return new Amount(bitcoin * ConversionFactor);
+    }
+    // Create an Amount object using satoshi unit.
+    static FromSatoshis(satoshis) {
+        return new Amount(satoshis);
+    }
+    // Get the amount value in bitcoin.
+    GetBitcoinAmount() {
+        return this._satoshis / ConversionFactor;
+    }
+    // Get the amount value in satoshi.
+    GetSatoshiAmount() {
+        return this._satoshis;
+    }
+    // Return a new Amount object with value increased by the given amount of
+    // satoshi.
+    AddSatoshis(satoshis) {
+        return new Amount(this._satoshis + satoshis);
+    }
+    // Return a new Amount object with value increased by the given amount of
+    // bitcoin.
+    AddBitcoins(bitcoins) {
+        return new Amount(this._satoshis + bitcoins * ConversionFactor);
+    }
+    // Return a new Amount object with value increased by the given amount.
+    AddAmount(amount) {
+        return new Amount(this._satoshis + amount._satoshis);
+    }
+    // Returns the difference between the amount of satoshi in this object and
+    // the amount of satoshi of the given object.
+    CompareWith(amount) {
+        return new Amount(this._satoshis - amount._satoshis);
+    }
+    toJSON() {
+        return Object.assign({}, this, {
+            _satoshis: this._satoshis,
+        });
+    }
+    static fromJSON(json) {
+        if (!json)
+            return;
+        const amount = Object.create(Amount.prototype);
+        return Object.assign(amount, json, {
+            _satoshis: json._satoshis,
+            GetSatoshiAmount: Amount.prototype.GetSatoshiAmount,
+        });
+    }
+    static reviver(key, value) {
+        return key === '' ? Amount.fromJSON(value) : value;
+    }
+}
+exports.default = Amount;
+//# sourceMappingURL=Amount.js.map

package/lib/models/Input.js

@@ -0,0 +1,75 @@
+"use strict";
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+const Amount_1 = __importDefault(require("./Amount"));
+const Utxo_1 = __importDefault(require("./Utxo"));
+/**
+ * Class for interfacing with inputs/utxos in Liquality Chainify
+ * https://github.com/liquality/chainify
+ *
+ * These inputs can have different fields for value
+ * satoshis (sats): https://github.com/liquality/chainify/blob/dev/packages/bitcoin-esplora-api-provider/lib/BitcoinEsploraApiProvider.js#L65
+ * amount (btc): https://github.com/liquality/chainify/blob/dev/packages/bitcoin-esplora-api-provider/lib/BitcoinEsploraApiProvider.js#L74
+ * value (sats): https://github.com/liquality/chainify/blob/dev/packages/bitcoin-wallet-provider/lib/BitcoinWalletProvider.js#L331
+ *
+ * This will be fixed once typescript branch is merged:
+ * https://github.com/liquality/chainify/tree/typescript
+ * satoshis and amount will not be necessary, only value
+ * https://github.com/liquality/chainify/blob/typescript/packages/types/lib/bitcoin.ts#L46
+ */
+class Input {
+    constructor(txid, vout, address, amount, // in BTC
+    value, // in sats
+    derivationPath, maxWitnessLength, redeemScript, inputSerialId, scriptPubKey, label, confirmations, spendable, solvable, safe) {
+        this.txid = txid;
+        this.vout = vout;
+        this.address = address;
+        this.amount = amount;
+        this.value = value;
+        this.derivationPath = derivationPath;
+        this.maxWitnessLength = maxWitnessLength;
+        this.redeemScript = redeemScript;
+        this.inputSerialId = inputSerialId;
+        this.scriptPubKey = scriptPubKey;
+        this.label = label;
+        this.confirmations = confirmations;
+        this.spendable = spendable;
+        this.solvable = solvable;
+        this.safe = safe;
+    }
+    toUtxo() {
+        let amount;
+        if (this.value) {
+            amount = Amount_1.default.FromSatoshis(this.value);
+        }
+        else if (this.amount) {
+            amount = Amount_1.default.FromBitcoin(this.amount);
+        }
+        return {
+            txid: this.txid,
+            vout: this.vout,
+            amount,
+            address: this.address,
+            derivationPath: this.derivationPath,
+            maxWitnessLength: this.maxWitnessLength ? this.maxWitnessLength : 108,
+            inputSerialId: this.inputSerialId,
+            toJSON: Utxo_1.default.prototype.toJSON,
+            toInput: Utxo_1.default.prototype.toInput,
+        };
+    }
+    static fromUTXO(utxo) {
+        const amount = Amount_1.default.FromSatoshis(utxo.value);
+        return {
+            txid: utxo.txid,
+            vout: utxo.vout,
+            address: utxo.address,
+            value: utxo.value,
+            amount: amount.GetBitcoinAmount(),
+            toUtxo: Input.prototype.toUtxo,
+        };
+    }
+}
+exports.default = Input;
+//# sourceMappingURL=Input.js.map

package/lib/models/OracleInfo.js

@@ -0,0 +1,11 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+class OracleInfo {
+    constructor(name, rValues, publicKey) {
+        this.name = name;
+        this.rValues = rValues;
+        this.publicKey = publicKey;
+    }
+}
+exports.default = OracleInfo;
+//# sourceMappingURL=OracleInfo.js.map

package/lib/models/Outcome.js

@@ -0,0 +1,33 @@
+"use strict";
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+const Amount_1 = __importDefault(require("./Amount"));
+class Outcome {
+    constructor(message, local, remote) {
+        this.message = message;
+        this.local = local;
+        this.remote = remote;
+    }
+    toJSON() {
+        return Object.assign({}, this, {
+            message: this.message,
+            local: this.local.toJSON(),
+            remote: this.remote.toJSON(),
+        });
+    }
+    static fromJSON(json) {
+        const outcome = Object.create(Outcome.prototype);
+        return Object.assign(outcome, json, {
+            message: json.message,
+            local: Amount_1.default.fromJSON(json.local),
+            remote: Amount_1.default.fromJSON(json.remote),
+        });
+    }
+    static reviver(key, value) {
+        return key === '' ? Outcome.fromJSON(value) : value;
+    }
+}
+exports.default = Outcome;
+//# sourceMappingURL=Outcome.js.map

package/lib/models/Output.js

@@ -0,0 +1,10 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+class Output {
+    constructor(value, to) {
+        this.value = value;
+        this.to = to;
+    }
+}
+exports.default = Output;
+//# sourceMappingURL=Output.js.map

package/lib/models/Utxo.js

@@ -0,0 +1,62 @@
+"use strict";
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+const Amount_1 = __importDefault(require("./Amount"));
+const Input_1 = __importDefault(require("./Input"));
+/**
+ * Class for interfacing with utxos in CFD DLC JS
+ * https://github.com/atomicfinance/cfd-dlc-js.git#v0.0.18
+ */
+class Utxo {
+    constructor(txid, vout, amount, address, derivationPath, maxWitnessLength, inputSerialId) {
+        this.txid = txid;
+        this.vout = vout;
+        this.amount = amount;
+        this.address = address;
+        this.derivationPath = derivationPath;
+        this.maxWitnessLength = maxWitnessLength;
+        this.inputSerialId = inputSerialId;
+    }
+    toInput() {
+        return {
+            txid: this.txid,
+            vout: this.vout,
+            address: this.address,
+            amount: this.amount.GetBitcoinAmount(),
+            value: this.amount.GetSatoshiAmount(),
+            derivationPath: this.derivationPath,
+            maxWitnessLength: this.maxWitnessLength,
+            inputSerialId: BigInt(this.inputSerialId),
+            toUtxo: Input_1.default.prototype.toUtxo,
+        };
+    }
+    toJSON() {
+        return Object.assign({}, this, {
+            txid: this.txid,
+            vout: this.vout,
+            amount: this.amount.toJSON(),
+            address: this.address,
+            derivationPath: this.derivationPath,
+            maxWitnessLength: this.maxWitnessLength,
+            inputSerialId: this.inputSerialId,
+        });
+    }
+    static fromJSON(json) {
+        const utxo = Object.create(Utxo.prototype);
+        return Object.assign(utxo, json, {
+            txid: json.txid,
+            vout: json.vout,
+            amount: Amount_1.default.fromJSON(json.amount),
+            address: json.address,
+            derivationPath: json.derivationPath,
+            maxWitnessLength: json.maxWitnessLength,
+        });
+    }
+    static reviver(key, value) {
+        return key === '' ? Utxo.fromJSON(value) : value;
+    }
+}
+exports.default = Utxo;
+//# sourceMappingURL=Utxo.js.map

package/lib/network.js

@@ -0,0 +1,3 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+//# sourceMappingURL=network.js.map

package/lib/transaction.js

@@ -0,0 +1,10 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.TxStatus = void 0;
+var TxStatus;
+(function (TxStatus) {
+    TxStatus["Pending"] = "PENDING";
+    TxStatus["Failed"] = "FAILED";
+    TxStatus["Success"] = "SUCCESS";
+})(TxStatus = exports.TxStatus || (exports.TxStatus = {}));
+//# sourceMappingURL=transaction.js.map

package/lib/wallet.js

@@ -0,0 +1,3 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+//# sourceMappingURL=wallet.js.map

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@atomicfinance/types",
   "umdName": "Types",
-  "version": "3.5.0",
+  "version": "3.5.1",
   "description": "Bitcoin Abstraction Layer Types",
   "author": "Atomic Finance <info@atomic.finance>",
   "homepage": "",