Merge pull request #1079 from ProvableHQ/rr-return-num-constraints-for-vk

[Feature] Return number of constraints for VerifyingKey

Author: iamalwaysuncomfortable

docs/api_reference/sdk-src_network-client.md

@@ -1017,6 +1017,20 @@ __*return*__ | `Promise.<string>` | *The solution id of the submitted solution o
 
 ---
 
+### `submitProvingRequest(provingRequest, url) ► Promise.<ProvingResponse>`
+
+![modifier: public](images/badges/modifier-public.svg)
+
+Submit a &#x60;ProvingRequest&#x60; to a remote proving service for delegated proving. If the broadcast flag of the &#x60;ProvingRequest&#x60; is set to &#x60;true&#x60; the remote service will attempt to broadcast the result &#x60;Transaction&#x60; on behalf of the requestor.
+
+Parameters | Type | Description
+--- | --- | ---
+__provingRequest__ | [ProvingRequest](sdk-src_wasm.md) | *The &#x60;ProvingRequest&#x60; (generated by the ProgramManager) to submit.*
+__url__ | `string` | *(Optional) The url of the proving service.*
+__*return*__ | `Promise.<ProvingResponse>` | *The ProvingResponse containing the transaction result and the result of the broadcast if the &#x60;broadcast&#x60; flag was set to &#x60;true&#x60;.*
+
+---
+
 ### `waitForTransactionConfirmation(transactionId, checkInterval, timeout) ► Promise.<Transaction>`
 
 ![modifier: public](images/badges/modifier-public.svg)
@@ -2053,6 +2067,20 @@ __*return*__ | `Promise.<string>` | *The solution id of the submitted solution o
 
 ---
 
+### `submitProvingRequest(provingRequest, url) ► Promise.<ProvingResponse>`
+
+![modifier: public](images/badges/modifier-public.svg)
+
+Submit a &#x60;ProvingRequest&#x60; to a remote proving service for delegated proving. If the broadcast flag of the &#x60;ProvingRequest&#x60; is set to &#x60;true&#x60; the remote service will attempt to broadcast the result &#x60;Transaction&#x60; on behalf of the requestor.
+
+Parameters | Type | Description
+--- | --- | ---
+__provingRequest__ | [ProvingRequest](sdk-src_wasm.md) | *The &#x60;ProvingRequest&#x60; (generated by the ProgramManager) to submit.*
+__url__ | `string` | *(Optional) The url of the proving service.*
+__*return*__ | `Promise.<ProvingResponse>` | *The ProvingResponse containing the transaction result and the result of the broadcast if the &#x60;broadcast&#x60; flag was set to &#x60;true&#x60;.*
+
+---
+
 ### `waitForTransactionConfirmation(transactionId, checkInterval, timeout) ► Promise.<Transaction>`
 
 ![modifier: public](images/badges/modifier-public.svg)

docs/api_reference/sdk-src_wasm.md

@@ -3277,6 +3277,18 @@ __*return*__ | [Plaintext](sdk-src_wasm.md) | **
 
 ---
 
+### `toField() ► Field`
+
+![modifier: public](images/badges/modifier-public.svg)
+
+Cast the scalar element to a field element.
+
+Parameters | Type | Description
+--- | --- | ---
+__*return*__ | [Field](sdk-src_wasm.md) | **
+
+---
+
 ### `clone() ► Scalar`
 
 ![modifier: public](images/badges/modifier-public.svg)
@@ -4330,3 +4342,15 @@ Parameters | Type | Description
 __*return*__ | `String` | *String representation of the verifying key*
 
 ---
+
+### `numConstraints() ► number`
+
+![modifier: public](images/badges/modifier-public.svg)
+
+Get the number of constraints associated with the circuit
+
+Parameters | Type | Description
+--- | --- | ---
+__*return*__ | `number` | *The number of constraints*
+
+---

sdk/tests/wasm.test.ts

@@ -1,5 +1,5 @@
 import { expect } from "chai";
-import { Address, AleoNetworkClient, Field, PrivateKey, ViewKey, Signature, RecordCiphertext, RecordPlaintext, PrivateKeyCiphertext, EncryptionToolkit, Transition } from "../src/node.js";
+import { Address, AleoNetworkClient, CREDITS_PROGRAM_KEYS, Field, FunctionKeyPair, PrivateKey, ViewKey, Signature, RecordCiphertext, RecordPlaintext, PrivateKeyCiphertext, EncryptionToolkit, Transition, VerifyingKey, AleoKeyProvider} from "../src/node.js";
 import {
     seed,
     message,
@@ -21,7 +21,6 @@ import {
     VIEW_KEY_STRING,
 } from "./data/records.js";
 
-
 describe('WASM Objects', () => {
     describe('Address', () => {
         it('can be constructed from a private key', () => {
@@ -485,4 +484,13 @@ describe('WASM Objects', () => {
             expect(decryptedRecords[0].toString()).equal(recordPlaintextCopy.toString());
         });
     });
-});
+    describe('VerifyingKey', () => {
+        it('can get the number of constraints', async () => {
+            const keyProvider = new AleoKeyProvider();
+            const [transferPublicProver, transferPublicVerifier] = <FunctionKeyPair>await keyProvider.fetchCreditsKeys(CREDITS_PROGRAM_KEYS.transfer_public);
+            const numConstraints = transferPublicVerifier.numConstraints();
+            expect(numConstraints).to.equal(12326);
+        });
+    });
+});
+

wasm/src/programs/verifying_key/mod.rs

@@ -83,6 +83,14 @@ impl VerifyingKey {
     pub fn to_string(&self) -> String {
         self.0.to_string()
     }
+
+    /// Get the number of constraints associated with the circuit
+    ///
+    /// @returns {number} The number of constraints
+    #[wasm_bindgen(js_name = "numConstraints")]
+    pub fn num_constraints(&self) -> u32 {
+        self.0.circuit_info.num_constraints as u32
+    }
 }
 
 impl Deref for VerifyingKey {
@@ -238,4 +246,13 @@ mod tests {
 
         assert_eq!(transfer_public_verifying_key_checksum, checksum);
     }
+
+    #[wasm_bindgen_test]
+    async fn test_num_constraints() {
+        let transfer_public_verifier_bytes =
+            crate::types::native::parameters::TransferPublicVerifier::load_bytes().unwrap();
+        let transfer_public_verifier = VerifyingKey::from_bytes(&transfer_public_verifier_bytes).unwrap();
+        let num_constraints = transfer_public_verifier.num_constraints();
+        assert_eq!(num_constraints, 12326);
+    }
 }