cashscript 0.6.5 → 0.7.0-next.0

package/dist/main/Argument.d.ts

@@ -1,3 +1,3 @@
 import SignatureTemplate from './SignatureTemplate';
-export declare type Argument = number | boolean | string | Uint8Array | SignatureTemplate;
+export declare type Argument = number | bigint | boolean | string | Uint8Array | SignatureTemplate;
 export declare function encodeArgument(argument: Argument, typeStr: string): Uint8Array | SignatureTemplate;

package/dist/main/Argument.js

@@ -17,7 +17,7 @@ function encodeArgument(argument, typeStr) {
         return utils_1.encodeBool(argument);
     }
     if (type === utils_1.PrimitiveType.INT) {
-        if (typeof argument !== 'number') {
+        if (typeof argument !== 'number' && typeof argument !== 'bigint') {
             throw new Errors_1.TypeError(typeof argument, type);
         }
         return utils_1.encodeInt(argument);
@@ -42,14 +42,14 @@ function encodeArgument(argument, typeStr) {
     }
     // Redefine SIG as a bytes65 so it is included in the size checks below
     // Note that ONLY Schnorr signatures are accepted
-    if (type === utils_1.PrimitiveType.SIG) {
+    if (type === utils_1.PrimitiveType.SIG && argument.byteLength !== 0) {
         type = new utils_1.BytesType(65);
     }
-    // TODO: Set DATASIG to 64 bytes (enforcing Schnorr) in a new MINOR version upgrade
-    // (backwards incompatible)
-    // if (type === PrimitiveType.DATASIG) {
-    //   type = new BytesType(64);
-    // }
+    // Redefine SIG as a bytes64 so it is included in the size checks below
+    // Note that ONLY Schnorr signatures are accepted
+    if (type === utils_1.PrimitiveType.DATASIG && argument.byteLength !== 0) {
+        type = new utils_1.BytesType(64);
+    }
     // Bounded bytes types require a correctly sized argument
     if (type instanceof utils_1.BytesType && type.bound && argument.byteLength !== type.bound) {
         throw new Errors_1.TypeError(`bytes${argument.byteLength}`, type);

package/dist/main/Errors.d.ts

@@ -2,6 +2,9 @@ import { Type } from '@cashscript/utils';
 export declare class TypeError extends Error {
     constructor(actual: string, expected: Type);
 }
+export declare class OutputSatoshisTooSmallError extends Error {
+    constructor(satoshis: number);
+}
 export declare class FailedTransactionError extends Error {
     reason: string;
     meep: string;
@@ -28,7 +31,7 @@ export declare enum Reason {
     SIG_COUNT = "Signature count negative or greater than pubkey count",
     PUBKEY_COUNT = "Pubkey count negative or limit exceeded",
     INVALID_OPERAND_SIZE = "Invalid operand size",
-    INVALID_NUMBER_RANGE = "Given operand is not a number within the valid range [-2^31...2^31]",
+    INVALID_NUMBER_RANGE = "Given operand is not a number within the valid range",
     IMPOSSIBLE_ENCODING = "The requested encoding is impossible to satisfy",
     INVALID_SPLIT_RANGE = "Invalid OP_SPLIT range",
     INVALID_BIT_COUNT = "Invalid number of bit set in OP_CHECKMULTISIG",
@@ -58,5 +61,6 @@ export declare enum Reason {
     CLEANSTACK = "Script did not clean its stack",
     NONCOMPRESSED_PUBKEY = "Using non-compressed public key",
     ILLEGAL_FORKID = "Illegal use of SIGHASH_FORKID",
-    MUST_USE_FORKID = "Signature must use SIGHASH_FORKID"
+    MUST_USE_FORKID = "Signature must use SIGHASH_FORKID",
+    UNKNOWN = "unknown error"
 }

package/dist/main/Errors.js

@@ -1,12 +1,19 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.Reason = exports.FailedSigCheckError = exports.FailedTimeCheckError = exports.FailedRequireError = exports.FailedTransactionError = exports.TypeError = void 0;
+exports.Reason = exports.FailedSigCheckError = exports.FailedTimeCheckError = exports.FailedRequireError = exports.FailedTransactionError = exports.OutputSatoshisTooSmallError = exports.TypeError = void 0;
+const constants_1 = require("./constants");
 class TypeError extends Error {
     constructor(actual, expected) {
         super(`Found type '${actual}' where type '${expected.toString()}' was expected`);
     }
 }
 exports.TypeError = TypeError;
+class OutputSatoshisTooSmallError extends Error {
+    constructor(satoshis) {
+        super(`Tried to add an output with ${satoshis} satoshis, which is less than the DUST limit (${constants_1.DUST_LIMIT})`);
+    }
+}
+exports.OutputSatoshisTooSmallError = OutputSatoshisTooSmallError;
 class FailedTransactionError extends Error {
     constructor(reason, meep) {
         super(`Transaction failed with reason: ${reason}\n${meep}`);
@@ -41,7 +48,7 @@ var Reason;
     Reason["SIG_COUNT"] = "Signature count negative or greater than pubkey count";
     Reason["PUBKEY_COUNT"] = "Pubkey count negative or limit exceeded";
     Reason["INVALID_OPERAND_SIZE"] = "Invalid operand size";
-    Reason["INVALID_NUMBER_RANGE"] = "Given operand is not a number within the valid range [-2^31...2^31]";
+    Reason["INVALID_NUMBER_RANGE"] = "Given operand is not a number within the valid range";
     Reason["IMPOSSIBLE_ENCODING"] = "The requested encoding is impossible to satisfy";
     Reason["INVALID_SPLIT_RANGE"] = "Invalid OP_SPLIT range";
     Reason["INVALID_BIT_COUNT"] = "Invalid number of bit set in OP_CHECKMULTISIG";
@@ -72,5 +79,6 @@ var Reason;
     Reason["NONCOMPRESSED_PUBKEY"] = "Using non-compressed public key";
     Reason["ILLEGAL_FORKID"] = "Illegal use of SIGHASH_FORKID";
     Reason["MUST_USE_FORKID"] = "Signature must use SIGHASH_FORKID";
+    Reason["UNKNOWN"] = "unknown error";
 })(Reason = exports.Reason || (exports.Reason = {}));
 //# sourceMappingURL=Errors.js.map

package/dist/main/Transaction.js

@@ -52,15 +52,14 @@ class Transaction {
     }
     to(toOrOutputs, amount) {
         if (typeof toOrOutputs === 'string' && typeof amount === 'number') {
-            this.outputs.push({ to: toOrOutputs, amount });
+            return this.to([{ to: toOrOutputs, amount }]);
         }
-        else if (Array.isArray(toOrOutputs) && amount === undefined) {
+        if (Array.isArray(toOrOutputs) && amount === undefined) {
+            toOrOutputs.forEach(utils_2.validateRecipient);
             this.outputs = this.outputs.concat(toOrOutputs);
+            return this;
         }
-        else {
-            throw new Error('Incorrect arguments passed to function \'to\'');
-        }
-        return this;
+        throw new Error('Incorrect arguments passed to function \'to\'');
     }
     withOpReturn(chunks) {
         this.outputs.push(utils_2.createOpReturnOutput(chunks));

package/dist/main/interfaces.d.ts

@@ -30,6 +30,7 @@ export declare enum HashType {
 export declare const Network: {
     MAINNET: "mainnet";
     TESTNET: "testnet";
+    STAGING: "staging";
     REGTEST: "regtest";
 };
 export declare type Network = (typeof Network)[keyof typeof Network];

package/dist/main/interfaces.js

@@ -23,6 +23,7 @@ const literal = (l) => l;
 exports.Network = {
     MAINNET: literal('mainnet'),
     TESTNET: literal('testnet'),
+    STAGING: literal('staging'),
     REGTEST: literal('regtest'),
 };
 //# sourceMappingURL=interfaces.js.map

package/dist/main/network/ElectrumNetworkProvider.js

@@ -37,12 +37,16 @@ class ElectrumNetworkProvider {
         }
         else if (network === interfaces_1.Network.TESTNET) {
             // Initialise a 1-of-2 Electrum Cluster with 2 hardcoded servers
-            this.electrum = new electrum_cash_1.ElectrumCluster('CashScript Application', '1.4.1', 1, 2);
+            this.electrum = new electrum_cash_1.ElectrumCluster('CashScript Application', '1.4.1', 1, 2, electrum_cash_1.ClusterOrder.PRIORITY);
             this.electrum.addServer('blackie.c3-soft.com', 60004, electrum_cash_1.ElectrumTransport.WSS.Scheme, false);
             this.electrum.addServer('electroncash.de', 60004, electrum_cash_1.ElectrumTransport.WSS.Scheme, false);
             // this.electrum.addServer('bch.loping.net', 60004, ElectrumTransport.WSS.Scheme, false);
             // this.electrum.addServer('testnet.imaginary.cash', 50004, ElectrumTransport.WSS.Scheme);
         }
+        else if (network === interfaces_1.Network.STAGING) {
+            this.electrum = new electrum_cash_1.ElectrumCluster('CashScript Application', '1.4.1', 1, 1, electrum_cash_1.ClusterOrder.PRIORITY);
+            this.electrum.addServer('testnet4.imaginary.cash', 50004, electrum_cash_1.ElectrumTransport.WSS.Scheme, false);
+        }
         else {
             throw new Error(`Tried to instantiate an ElectrumNetworkProvider for unsupported network ${network}`);
         }

package/dist/main/utils.d.ts

@@ -1,7 +1,8 @@
 import { Transaction } from '@bitauth/libauth';
 import { Script } from '@cashscript/utils';
-import { Utxo, Output } from './interfaces';
+import { Utxo, Output, Recipient } from './interfaces';
 import { FailedTransactionError } from './Errors';
+export declare function validateRecipient(recipient: Recipient): void;
 export declare function getInputSize(inputScript: Uint8Array): number;
 export declare function getPreimageSize(script: Uint8Array): number;
 export declare function getTxSizeWithoutInputs(outputs: Output[]): number;

package/dist/main/utils.js

@@ -1,11 +1,18 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.getNetworkPrefix = exports.addressToLockScript = exports.scriptToLockingBytecode = exports.scriptToAddress = exports.meep = exports.buildError = exports.createSighashPreimage = exports.createOpReturnOutput = exports.createInputScript = exports.getTxSizeWithoutInputs = exports.getPreimageSize = exports.getInputSize = void 0;
+exports.getNetworkPrefix = exports.addressToLockScript = exports.scriptToLockingBytecode = exports.scriptToAddress = exports.meep = exports.buildError = exports.createSighashPreimage = exports.createOpReturnOutput = exports.createInputScript = exports.getTxSizeWithoutInputs = exports.getPreimageSize = exports.getInputSize = exports.validateRecipient = void 0;
 const libauth_1 = require("@bitauth/libauth");
 const utils_1 = require("@cashscript/utils");
 const interfaces_1 = require("./interfaces");
 const constants_1 = require("./constants");
 const Errors_1 = require("./Errors");
+// ////////// PARAMETER VALIDATION ////////////////////////////////////////////
+function validateRecipient(recipient) {
+    if (recipient.amount < constants_1.DUST_LIMIT) {
+        throw new Errors_1.OutputSatoshisTooSmallError(recipient.amount);
+    }
+}
+exports.validateRecipient = validateRecipient;
 // ////////// SIZE CALCULATIONS ///////////////////////////////////////////////
 function getInputSize(inputScript) {
     const scriptSize = inputScript.byteLength;
@@ -161,6 +168,8 @@ function getNetworkPrefix(network) {
     switch (network) {
         case interfaces_1.Network.MAINNET:
             return 'bitcoincash';
+        case interfaces_1.Network.STAGING:
+            return 'bchtest';
         case interfaces_1.Network.TESTNET:
             return 'bchtest';
         case interfaces_1.Network.REGTEST:

package/dist/module/Argument.d.ts

@@ -1,3 +1,3 @@
 import SignatureTemplate from './SignatureTemplate';
-export declare type Argument = number | boolean | string | Uint8Array | SignatureTemplate;
+export declare type Argument = number | bigint | boolean | string | Uint8Array | SignatureTemplate;
 export declare function encodeArgument(argument: Argument, typeStr: string): Uint8Array | SignatureTemplate;

package/dist/module/Argument.js

@@ -11,7 +11,7 @@ export function encodeArgument(argument, typeStr) {
         return encodeBool(argument);
     }
     if (type === PrimitiveType.INT) {
-        if (typeof argument !== 'number') {
+        if (typeof argument !== 'number' && typeof argument !== 'bigint') {
             throw new TypeError(typeof argument, type);
         }
         return encodeInt(argument);
@@ -36,14 +36,14 @@ export function encodeArgument(argument, typeStr) {
     }
     // Redefine SIG as a bytes65 so it is included in the size checks below
     // Note that ONLY Schnorr signatures are accepted
-    if (type === PrimitiveType.SIG) {
+    if (type === PrimitiveType.SIG && argument.byteLength !== 0) {
         type = new BytesType(65);
     }
-    // TODO: Set DATASIG to 64 bytes (enforcing Schnorr) in a new MINOR version upgrade
-    // (backwards incompatible)
-    // if (type === PrimitiveType.DATASIG) {
-    //   type = new BytesType(64);
-    // }
+    // Redefine SIG as a bytes64 so it is included in the size checks below
+    // Note that ONLY Schnorr signatures are accepted
+    if (type === PrimitiveType.DATASIG && argument.byteLength !== 0) {
+        type = new BytesType(64);
+    }
     // Bounded bytes types require a correctly sized argument
     if (type instanceof BytesType && type.bound && argument.byteLength !== type.bound) {
         throw new TypeError(`bytes${argument.byteLength}`, type);

package/dist/module/Errors.d.ts

@@ -2,6 +2,9 @@ import { Type } from '@cashscript/utils';
 export declare class TypeError extends Error {
     constructor(actual: string, expected: Type);
 }
+export declare class OutputSatoshisTooSmallError extends Error {
+    constructor(satoshis: number);
+}
 export declare class FailedTransactionError extends Error {
     reason: string;
     meep: string;
@@ -28,7 +31,7 @@ export declare enum Reason {
     SIG_COUNT = "Signature count negative or greater than pubkey count",
     PUBKEY_COUNT = "Pubkey count negative or limit exceeded",
     INVALID_OPERAND_SIZE = "Invalid operand size",
-    INVALID_NUMBER_RANGE = "Given operand is not a number within the valid range [-2^31...2^31]",
+    INVALID_NUMBER_RANGE = "Given operand is not a number within the valid range",
     IMPOSSIBLE_ENCODING = "The requested encoding is impossible to satisfy",
     INVALID_SPLIT_RANGE = "Invalid OP_SPLIT range",
     INVALID_BIT_COUNT = "Invalid number of bit set in OP_CHECKMULTISIG",
@@ -58,5 +61,6 @@ export declare enum Reason {
     CLEANSTACK = "Script did not clean its stack",
     NONCOMPRESSED_PUBKEY = "Using non-compressed public key",
     ILLEGAL_FORKID = "Illegal use of SIGHASH_FORKID",
-    MUST_USE_FORKID = "Signature must use SIGHASH_FORKID"
+    MUST_USE_FORKID = "Signature must use SIGHASH_FORKID",
+    UNKNOWN = "unknown error"
 }

package/dist/module/Errors.js

@@ -1,8 +1,14 @@
+import { DUST_LIMIT } from './constants';
 export class TypeError extends Error {
     constructor(actual, expected) {
         super(`Found type '${actual}' where type '${expected.toString()}' was expected`);
     }
 }
+export class OutputSatoshisTooSmallError extends Error {
+    constructor(satoshis) {
+        super(`Tried to add an output with ${satoshis} satoshis, which is less than the DUST limit (${DUST_LIMIT})`);
+    }
+}
 export class FailedTransactionError extends Error {
     constructor(reason, meep) {
         super(`Transaction failed with reason: ${reason}\n${meep}`);
@@ -33,7 +39,7 @@ export var Reason;
     Reason["SIG_COUNT"] = "Signature count negative or greater than pubkey count";
     Reason["PUBKEY_COUNT"] = "Pubkey count negative or limit exceeded";
     Reason["INVALID_OPERAND_SIZE"] = "Invalid operand size";
-    Reason["INVALID_NUMBER_RANGE"] = "Given operand is not a number within the valid range [-2^31...2^31]";
+    Reason["INVALID_NUMBER_RANGE"] = "Given operand is not a number within the valid range";
     Reason["IMPOSSIBLE_ENCODING"] = "The requested encoding is impossible to satisfy";
     Reason["INVALID_SPLIT_RANGE"] = "Invalid OP_SPLIT range";
     Reason["INVALID_BIT_COUNT"] = "Invalid number of bit set in OP_CHECKMULTISIG";
@@ -64,5 +70,6 @@ export var Reason;
     Reason["NONCOMPRESSED_PUBKEY"] = "Using non-compressed public key";
     Reason["ILLEGAL_FORKID"] = "Illegal use of SIGHASH_FORKID";
     Reason["MUST_USE_FORKID"] = "Signature must use SIGHASH_FORKID";
+    Reason["UNKNOWN"] = "unknown error";
 })(Reason || (Reason = {}));
 //# sourceMappingURL=Errors.js.map

package/dist/module/Transaction.js

@@ -11,7 +11,7 @@ import { bigIntToBinUint64LE, hexToBin, binToHex, encodeTransaction, addressCont
 import delay from 'delay';
 import { hash160, hash256, placeholder, scriptToBytecode, } from '@cashscript/utils';
 import { isSignableUtxo, } from './interfaces';
-import { meep, createInputScript, getInputSize, createOpReturnOutput, getTxSizeWithoutInputs, getPreimageSize, buildError, addressToLockScript, createSighashPreimage, } from './utils';
+import { meep, createInputScript, getInputSize, createOpReturnOutput, getTxSizeWithoutInputs, getPreimageSize, buildError, addressToLockScript, createSighashPreimage, validateRecipient, } from './utils';
 import { P2SH_OUTPUT_SIZE, DUST_LIMIT } from './constants';
 import SignatureTemplate from './SignatureTemplate';
 const bip68 = require('bip68');
@@ -46,15 +46,14 @@ export class Transaction {
     }
     to(toOrOutputs, amount) {
         if (typeof toOrOutputs === 'string' && typeof amount === 'number') {
-            this.outputs.push({ to: toOrOutputs, amount });
+            return this.to([{ to: toOrOutputs, amount }]);
         }
-        else if (Array.isArray(toOrOutputs) && amount === undefined) {
+        if (Array.isArray(toOrOutputs) && amount === undefined) {
+            toOrOutputs.forEach(validateRecipient);
             this.outputs = this.outputs.concat(toOrOutputs);
+            return this;
         }
-        else {
-            throw new Error('Incorrect arguments passed to function \'to\'');
-        }
-        return this;
+        throw new Error('Incorrect arguments passed to function \'to\'');
     }
     withOpReturn(chunks) {
         this.outputs.push(createOpReturnOutput(chunks));

package/dist/module/interfaces.d.ts

@@ -30,6 +30,7 @@ export declare enum HashType {
 export declare const Network: {
     MAINNET: "mainnet";
     TESTNET: "testnet";
+    STAGING: "staging";
     REGTEST: "regtest";
 };
 export declare type Network = (typeof Network)[keyof typeof Network];

package/dist/module/interfaces.js

@@ -19,6 +19,7 @@ const literal = (l) => l;
 export const Network = {
     MAINNET: literal('mainnet'),
     TESTNET: literal('testnet'),
+    STAGING: literal('staging'),
     REGTEST: literal('regtest'),
 };
 //# sourceMappingURL=interfaces.js.map

package/dist/module/network/ElectrumNetworkProvider.js

@@ -35,12 +35,16 @@ export default class ElectrumNetworkProvider {
         }
         else if (network === Network.TESTNET) {
             // Initialise a 1-of-2 Electrum Cluster with 2 hardcoded servers
-            this.electrum = new ElectrumCluster('CashScript Application', '1.4.1', 1, 2);
+            this.electrum = new ElectrumCluster('CashScript Application', '1.4.1', 1, 2, ClusterOrder.PRIORITY);
             this.electrum.addServer('blackie.c3-soft.com', 60004, ElectrumTransport.WSS.Scheme, false);
             this.electrum.addServer('electroncash.de', 60004, ElectrumTransport.WSS.Scheme, false);
             // this.electrum.addServer('bch.loping.net', 60004, ElectrumTransport.WSS.Scheme, false);
             // this.electrum.addServer('testnet.imaginary.cash', 50004, ElectrumTransport.WSS.Scheme);
         }
+        else if (network === Network.STAGING) {
+            this.electrum = new ElectrumCluster('CashScript Application', '1.4.1', 1, 1, ClusterOrder.PRIORITY);
+            this.electrum.addServer('testnet4.imaginary.cash', 50004, ElectrumTransport.WSS.Scheme, false);
+        }
         else {
             throw new Error(`Tried to instantiate an ElectrumNetworkProvider for unsupported network ${network}`);
         }

package/dist/module/utils.d.ts

@@ -1,7 +1,8 @@
 import { Transaction } from '@bitauth/libauth';
 import { Script } from '@cashscript/utils';
-import { Utxo, Output } from './interfaces';
+import { Utxo, Output, Recipient } from './interfaces';
 import { FailedTransactionError } from './Errors';
+export declare function validateRecipient(recipient: Recipient): void;
 export declare function getInputSize(inputScript: Uint8Array): number;
 export declare function getPreimageSize(script: Uint8Array): number;
 export declare function getTxSizeWithoutInputs(outputs: Output[]): number;

package/dist/module/utils.js

@@ -1,8 +1,14 @@
 import { cashAddressToLockingBytecode, AddressType, addressContentsToLockingBytecode, lockingBytecodeToCashAddress, binToHex, createTransactionContextCommon, bigIntToBinUint64LE, generateSigningSerializationBCH, utf8ToBin, hexToBin, flattenBinArray, } from '@bitauth/libauth';
 import { encodeInt, hash160, Op, scriptToBytecode, sha256, } from '@cashscript/utils';
-import { Network } from './interfaces';
-import { P2PKH_OUTPUT_SIZE, VERSION_SIZE, LOCKTIME_SIZE } from './constants';
-import { Reason, FailedTransactionError, FailedRequireError, FailedTimeCheckError, FailedSigCheckError, } from './Errors';
+import { Network, } from './interfaces';
+import { P2PKH_OUTPUT_SIZE, VERSION_SIZE, LOCKTIME_SIZE, DUST_LIMIT, } from './constants';
+import { OutputSatoshisTooSmallError, Reason, FailedTransactionError, FailedRequireError, FailedTimeCheckError, FailedSigCheckError, } from './Errors';
+// ////////// PARAMETER VALIDATION ////////////////////////////////////////////
+export function validateRecipient(recipient) {
+    if (recipient.amount < DUST_LIMIT) {
+        throw new OutputSatoshisTooSmallError(recipient.amount);
+    }
+}
 // ////////// SIZE CALCULATIONS ///////////////////////////////////////////////
 export function getInputSize(inputScript) {
     const scriptSize = inputScript.byteLength;
@@ -147,6 +153,8 @@ export function getNetworkPrefix(network) {
     switch (network) {
         case Network.MAINNET:
             return 'bitcoincash';
+        case Network.STAGING:
+            return 'bchtest';
         case Network.TESTNET:
             return 'bchtest';
         case Network.REGTEST:

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "cashscript",
-  "version": "0.6.5",
+  "version": "0.7.0-next.0",
   "description": "Easily write and interact with Bitcoin Cash contracts",
   "keywords": [
     "bitcoin cash",
@@ -42,7 +42,7 @@
   },
   "dependencies": {
     "@bitauth/libauth": "^1.18.1",
-    "@cashscript/utils": "^0.6.5",
+    "@cashscript/utils": "^0.7.0-next.0",
     "bip68": "^1.0.4",
     "bitcoin-rpc-promise-retry": "^1.3.0",
     "delay": "^5.0.0",