@partisiablockchain/abi-client 6.37.0 → 6.62.0

package/package.json

@@ -1,11 +1,11 @@
 {
   "name": "@partisiablockchain/abi-client",
-  "version": "6.37.0",
+  "version": "6.62.0",
   "description": "",
   "license": "AGPL-3.0",
   "dependencies": {
-    "@partisiablockchain/blockchain-api-transaction-client": "6.32.0",
-    "@partisiablockchain/sections": "6.8.0",
+    "@partisiablockchain/blockchain-api-transaction-client": "6.51.0",
+    "@partisiablockchain/sections": "6.14.0",
     "@secata-public/bitmanipulation-ts": "3.4.0",
     "@types/bn.js": "^5.1.6",
     "@types/elliptic": "^6.4.18",

package/target/main/deploymentclient/BlockchainClientForDeploymentImpl.d.ts

@@ -13,7 +13,7 @@ export declare class BlockchainClientForDeploymentImpl implements BlockchainClie
      * @param transactionClient the underlying transaction client
      * @param chainController the underlying chainController
      */
-    constructor(transactionClient: BlockchainTransactionClient, chainController: ChainControllerApi);
+    constructor(transactionClient: BlockchainTransactionClient | undefined, chainController: ChainControllerApi | undefined);
     getContract(address: string): Promise<Contract>;
     sign(transaction: Transaction, gasCost: number): Promise<SignedTransaction>;
     send(signedTransaction: SignedTransaction): Promise<SentTransaction>;

package/target/main/deploymentclient/BlockchainClientForDeploymentImpl.js

@@ -34,15 +34,27 @@ class BlockchainClientForDeploymentImpl {
         this.chainController = chainController;
     }
     getContract(address) {
+        if (this.chainController === undefined) {
+            throw new Error("ChainController is undefined");
+        }
         return this.chainController.getContract({ address });
     }
     sign(transaction, gasCost) {
+        if (this.transactionClient === undefined) {
+            throw new Error("Transaction client is undefined");
+        }
         return this.transactionClient.sign(transaction, gasCost);
     }
     send(signedTransaction) {
+        if (this.transactionClient === undefined) {
+            throw new Error("Transaction client is undefined");
+        }
         return this.transactionClient.send(signedTransaction);
     }
     waitForSpawnedEvents(sentTransaction) {
+        if (this.transactionClient === undefined) {
+            throw new Error("Transaction client is undefined");
+        }
         return this.transactionClient.waitForSpawnedEvents(sentTransaction);
     }
 }

package/target/main/deploymentclient/BlockchainClientForDeploymentImpl.js.map

@@ -1 +1 @@
-{"version":3,"file":"BlockchainClientForDeploymentImpl.js","sourceRoot":"","sources":["../../../src/main/deploymentclient/BlockchainClientForDeploymentImpl.ts"],"names":[],"mappings":";AAAA;;;;;;;;;;;;;;;;GAgBG;;;AAaH;;;GAGG;AACH,MAAa,iCAAiC;IAI5C;;;;;OAKG;IACH,YAAY,iBAA8C,EAAE,eAAmC;QAC7F,IAAI,CAAC,iBAAiB,GAAG,iBAAiB,CAAC;QAC3C,IAAI,CAAC,eAAe,GAAG,eAAe,CAAC;IACzC,CAAC;IAED,WAAW,CAAC,OAAe;QACzB,OAAO,IAAI,CAAC,eAAe,CAAC,WAAW,CAAC,EAAE,OAAO,EAAE,CAAC,CAAC;IACvD,CAAC;IAED,IAAI,CAAC,WAAwB,EAAE,OAAe;QAC5C,OAAO,IAAI,CAAC,iBAAiB,CAAC,IAAI,CAAC,WAAW,EAAE,OAAO,CAAC,CAAC;IAC3D,CAAC;IAED,IAAI,CAAC,iBAAoC;QACvC,OAAO,IAAI,CAAC,iBAAiB,CAAC,IAAI,CAAC,iBAAiB,CAAC,CAAC;IACxD,CAAC;IAED,oBAAoB,CAAC,eAAgC;QACnD,OAAO,IAAI,CAAC,iBAAiB,CAAC,oBAAoB,CAAC,eAAe,CAAC,CAAC;IACtE,CAAC;CACF;AA9BD,8EA8BC"}
+{"version":3,"file":"BlockchainClientForDeploymentImpl.js","sourceRoot":"","sources":["../../../src/main/deploymentclient/BlockchainClientForDeploymentImpl.ts"],"names":[],"mappings":";AAAA;;;;;;;;;;;;;;;;GAgBG;;;AAaH;;;GAGG;AACH,MAAa,iCAAiC;IAI5C;;;;;OAKG;IACH,YACE,iBAA0D,EAC1D,eAA+C;QAE/C,IAAI,CAAC,iBAAiB,GAAG,iBAAiB,CAAC;QAC3C,IAAI,CAAC,eAAe,GAAG,eAAe,CAAC;IACzC,CAAC;IAED,WAAW,CAAC,OAAe;QACzB,IAAI,IAAI,CAAC,eAAe,KAAK,SAAS,EAAE,CAAC;YACvC,MAAM,IAAI,KAAK,CAAC,8BAA8B,CAAC,CAAC;QAClD,CAAC;QACD,OAAO,IAAI,CAAC,eAAe,CAAC,WAAW,CAAC,EAAE,OAAO,EAAE,CAAC,CAAC;IACvD,CAAC;IAED,IAAI,CAAC,WAAwB,EAAE,OAAe;QAC5C,IAAI,IAAI,CAAC,iBAAiB,KAAK,SAAS,EAAE,CAAC;YACzC,MAAM,IAAI,KAAK,CAAC,iCAAiC,CAAC,CAAC;QACrD,CAAC;QACD,OAAO,IAAI,CAAC,iBAAiB,CAAC,IAAI,CAAC,WAAW,EAAE,OAAO,CAAC,CAAC;IAC3D,CAAC;IAED,IAAI,CAAC,iBAAoC;QACvC,IAAI,IAAI,CAAC,iBAAiB,KAAK,SAAS,EAAE,CAAC;YACzC,MAAM,IAAI,KAAK,CAAC,iCAAiC,CAAC,CAAC;QACrD,CAAC;QACD,OAAO,IAAI,CAAC,iBAAiB,CAAC,IAAI,CAAC,iBAAiB,CAAC,CAAC;IACxD,CAAC;IAED,oBAAoB,CAAC,eAAgC;QACnD,IAAI,IAAI,CAAC,iBAAiB,KAAK,SAAS,EAAE,CAAC;YACzC,MAAM,IAAI,KAAK,CAAC,iCAAiC,CAAC,CAAC;QACrD,CAAC;QACD,OAAO,IAAI,CAAC,iBAAiB,CAAC,oBAAoB,CAAC,eAAe,CAAC,CAAC;IACtE,CAAC;CACF;AA7CD,8EA6CC"}

package/target/main/deploymentclient/DeploymentBuilder.d.ts

@@ -1,9 +1,10 @@
-import { BlockchainClientForDeployment, DeployResult, VersionInterval } from "./DeploymentTypes";
+import { BlockchainClientForDeployment, DeployResult, InputFiles, PubState, RealState, Result, ValidationResult, ValidationSuccess, Version, VersionInterval } from "./DeploymentTypes";
 import { PbcFile } from "@partisiablockchain/sections";
 import { ContractAbi } from "../model/ContractAbi";
 import { AbiVersion } from "../model/AbiVersion";
 import { SignedTransaction, TransactionTree } from "@partisiablockchain/blockchain-api-transaction-client";
 import { AbstractBuilder } from "../builder/AbstractBuilder";
+import { FileAbi } from "../model/FileAbi";
 export declare class DeploymentBuilder {
     static readonly DEFAULT_PUB_ADDRESS: string;
     static readonly DEFAULT_REAL_ADDRESS: string;
@@ -12,15 +13,16 @@ export declare class DeploymentBuilder {
     private static readonly DEFAULT_PUB_GAS_COST;
     private static readonly DEFAULT_REAL_GAS_COST;
     private readonly blockchainClient;
+    private pubState;
+    private realState;
     private isZk;
-    private contractBytes;
-    private abiBytes;
+    private pbcFileField;
     private initRpcBytes;
     private deployContractAddressField;
     private allowedJurisdictionsField;
+    private specificNodesField;
     private requiredStakesField;
     private gasCostField;
-    private binderIdField;
     constructor(blockchainClient: BlockchainClientForDeployment);
     /**
      * Set the abi and contract bytes to deploy through a pbc file.
@@ -31,38 +33,7 @@ export declare class DeploymentBuilder {
      * @param pbcFile the pbc file to deploy
      * @returns this builder
      */
-    pbcFile(pbcFile: PbcFile | Buffer): DeploymentBuilder;
-    /**
-     * Set the abi of the contract to deploy.
-     *
-     * <p>It is required to provide the abi either through this method or through {@link #pbcFile}.
-     *
-     * @param abi abi bytes to deploy
-     * @returns this builder
-     */
-    abi(abi: Buffer): DeploymentBuilder;
-    /**
-     * Set the contract bytes of the contract to deploy. Using this function denotes that it is a zk
-     * contract you are trying to deploy.
-     *
-     * <p>It is required to provide the contract bytes either though this method, {@link wasm}, or
-     * {@link pbcFile}.
-     *
-     * @param zkwa contract bytes to deploy
-     * @returns this builder
-     */
-    zkwa(zkwa: Buffer): DeploymentBuilder;
-    /**
-     * Set the contract bytes of the contract to deploy. Using this function denotes that it is a
-     * public contract you are trying to deploy.
-     *
-     * <p>It is required to provide the contract bytes either though this method, {@link #zkwa}, or
-     * {@link #pbcFile}.
-     *
-     * @param wasm contract bytes to deploy
-     * @returns this builder
-     */
-    wasm(wasm: Buffer): DeploymentBuilder;
+    pbcFile(pbcFile: PbcFile | Buffer | undefined): DeploymentBuilder;
     /**
      * Set the initialization bytes of the contract to deploy.
      *
@@ -110,6 +81,16 @@ export declare class DeploymentBuilder {
      * @returns this builder
      */
     allowedJurisdictions(allowedJurisdictions: number[][]): DeploymentBuilder;
+    /**
+     * Set the specific nodes that will be allocated to this zk contract.
+     *
+     * <p>This argument is not allowed if trying to deploy a public contract. It is not required if
+     * deploying a zk contract and nodes will by default be allocated according to the {@link #allowedJurisdictions}.
+     *
+     * @param nodes nodes to be allocated to this contract
+     * @returns this builder
+     */
+    specificNodes(nodes: [string, string, string, string]): DeploymentBuilder;
     /**
      * Set the required stakes from the nodes selected for the deployed zk contract.
      *
@@ -122,16 +103,6 @@ export declare class DeploymentBuilder {
      * @returns this builder
      */
     requiredStakes(requiredStakes: number): DeploymentBuilder;
-    /**
-     * Set the binder id used to determine which binder to deploy the contract with.
-     *
-     * <p>This argument is not required. By default it will read the state of the deploy contract to
-     * find a binder which supports the given contract.
-     *
-     * @param binderId binder id
-     * @returns this builder
-     */
-    binderId(binderId: number): DeploymentBuilder;
     /**
      * Set the gas cost used to deploy the contract.
      *
@@ -167,11 +138,101 @@ export declare class DeploymentBuilder {
     deploy(): Promise<DeployResult>;
     private validateRequiredParameters;
     private validateOptionalParameters;
-    private determineBinderId;
+    /**
+     * Validate that the supplied contracts can be deployed.
+     */
+    validateContract(): Promise<ValidationResult>;
     private realDeployRpc;
-    private pubDeployRpc;
     private getInitializationBytes;
+    getPubState(): Promise<PubState | undefined>;
+    getRealState(): Promise<RealState | undefined>;
+    private getContractState;
+    /**
+     * Validate that the supplied pbc file can be deployed using a deploy contract with the given
+     * state.
+     *
+     * @param pubState state of the public deploy contract
+     * @param realState state of the REAL deploy contract
+     * @param pbcFile the contract files as a pbc file
+     * @return a validation result containing either the successful validation or the error message
+     */
+    static validateContract(pubState: PubState | undefined, realState: RealState | undefined, pbcFile: Buffer | PbcFile | undefined): ValidationResult;
+    /**
+     * Create rpc needed for a deployment of public contract from a successful validation result and
+     * the contract initialization rpc.
+     *
+     * @param pubDeployAbi abi for the public deployment contract
+     * @param validationResult the successful deployment result
+     * @param initRpc the contract's initialization rpc
+     * @return the deployment rpc
+     */
+    static createPubDeployRpc(pubDeployAbi: ContractAbi, validationResult: ValidationSuccess, initRpc: Buffer): Buffer;
+    /**
+     * Create rpc needed for a deployment of REAL contract from a successful validation result and
+     * extra arguments.
+     *
+     * @param realDeployAbi abi for the REAL deployment contract
+     * @param validationResult the successful deployment result
+     * @param initRpc the contract's initialization rpc
+     * @param requiredStakes required stakes for the nodes to allocate towards this contract. If null
+     *     a default of 2000 MPC is used.
+     * @param allowedJurisdictions the jurisdictions that the nodes can be chosen from. If null all
+     *     jurisdictions are allowed.
+     * @return the deployment rpc
+     */
+    static createRealDeployRpc(realDeployAbi: ContractAbi, validationResult: ValidationSuccess, initRpc: Buffer, requiredStakes?: number, allowedJurisdictions?: number[][]): Buffer;
+    /**
+     * Create rpc needed for a deployment of REAL contract with specific nodes from a successful
+     * validation result and extra arguments.
+     *
+     * @param realDeployAbi abi for the REAL deployment contract
+     * @param validationResult the successful deployment result
+     * @param initRpc the contract's initialization rpc
+     * @param requiredStakes required stakes for the nodes to allocate towards this contract. If null
+     *     a default of 2000 MPC is used.
+     * @param specificNodes list of 4 nodes that will be allocated to this contract
+     * @return the deployment rpc
+     */
+    static createRealDeployRpc(realDeployAbi: ContractAbi, validationResult: ValidationSuccess, initRpc: Buffer, requiredStakes: number | undefined, specificNodes: [string, string, string, string]): Buffer;
 }
-export declare function getSupportedBinderVersions(deployState: Buffer, deployAbi: ContractAbi): Map<number, VersionInterval>;
-export declare function findBinderId(binders: Map<number, VersionInterval>, binderVersion: AbiVersion): number;
+export declare function parsePubState(abi: Buffer, serializedContract: Buffer): PubState;
+export declare function findBinderId(binders: {
+    [binderId: number]: {
+        versionInterval: VersionInterval;
+    };
+}, binderVersion: AbiVersion): number | undefined;
 export declare function findFailureCause(transactionTree: TransactionTree): string | undefined;
+export declare function parseAbi(abiBytes: Buffer): Result<FileAbi, ValidationResult>;
+export declare function unsupportedBinderError(abi: FileAbi, binders: {
+    [binderId: number]: {
+        versionInterval: VersionInterval;
+    };
+}): ValidationResult;
+export declare function unsupportedBinderDetails(contractVersion: Version, supportedVersions: Version[]): string[];
+export declare function isSupported(zkbcVersion: Version, supportedZkbcVersionMax: Version): boolean;
+/**
+ * Parse and validate that the ABI is well-formed.
+ *
+ * @param pbcFile pbc file to validate
+ * @return result of the parsed abi of the error if it couldn't be parsed
+ */
+export declare function validateInputFiles(pbcFile: Buffer | PbcFile | undefined): Result<InputFiles, ValidationResult>;
+/**
+ * Validate that the there exists a public binder that the supports the contract being deployed.
+ *
+ * @param pubState state of public deploy contract
+ * @param abi parsed abi of the contract to be deployed
+ * @param pbcFile pbc file containing the contract files
+ * @return a validation result containing either the successful validation or the error message
+ */
+export declare function validatePubVersions(pubState: PubState | undefined, abi: FileAbi, pbcFile: PbcFile): ValidationResult;
+/**
+ * Validate that the there exists a REAL binder that the supports the contract being deployed.
+ *
+ * @param realState state of REAL deploy contract
+ * @param abi parsed abi of the contract to be deployed
+ * @param pbcFile pbc file containing the contract files
+ * @return a validation result containing either the successful validation or the error message
+ */
+export declare function validateRealVersions(realState: RealState | undefined, abi: FileAbi, pbcFile: PbcFile): ValidationResult;
+export declare function isSpecificNodes(nodeSelection: number[][] | [string, string, string, string] | undefined): nodeSelection is [string, string, string, string];