Merge pull request #22 from casper-ecosystem/maciej/deploy-size

Validate the deploy size.

CHANGELOG.md

@@ -4,6 +4,12 @@ All notable changes to casper-client-sdk.
 
 The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/), and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
 
+## 1.0.35
+
+### Changed
+
+- Validate the size of the `Deploy`. Now `CasperServiceByJsonRPC.deploy` throws an error if the size of the deploy is larger then 1 megabyte.`
+
 ## 1.0.34
 
 ### Fixed

package.json

@@ -1,6 +1,6 @@
 {
   "name": "casper-client-sdk",
-  "version": "1.0.34",
+  "version": "1.0.35",
   "license": "Apache 2.0",
   "description": "SDK to interact with the Casper blockchain",
   "main": "dist/lib.node.js",

src/lib/DeployUtil.ts

@@ -978,3 +978,14 @@ export const addArgToDeploy = (
 
   return makeDeploy(deployParams, session, deploy.payment);
 };
+
+export const deploySizeInBytes = (deploy: Deploy): number => {
+  const hashSize = deploy.hash.length;
+  const bodySize = serializeBody(deploy.payment, deploy.session).length;
+  const headerSize = serializeHeader(deploy.header).length;
+  const approvalsSize = deploy.approvals.map(approval => {
+    return (approval.signature.length + approval.signer.length) / 2;
+  }).reduce((a, b) => a + b, 0);
+
+  return hashSize + headerSize + bodySize + approvalsSize;
+}

src/services/CasperServiceByJsonRPC.ts

@@ -336,6 +336,15 @@ export class CasperServiceByJsonRPC {
   }
 
   public async deploy(signedDeploy: DeployUtil.Deploy) {
+    const oneMegaByte = 1048576;
+    const size = DeployUtil.deploySizeInBytes(signedDeploy);
+    if(size > oneMegaByte) {
+      throw Error(
+        `Deploy can not be send, because it's too large: ${size} bytes. ` +
+        `Max size is 1 megabyte.`
+      );
+    }
+
     return await this.client.request({
       method: 'account_put_deploy',
       params: deployToJson(signedDeploy)

test/nctl/RPC.test.ts

@@ -1,12 +1,13 @@
 import { assert } from 'chai';
 import { CasperServiceByJsonRPC } from '../../src/services';
+import { Keys, DeployUtil, RuntimeArgs } from '../../src/index';
 
 let client = new CasperServiceByJsonRPC(
     'http://127.0.0.1:40101/rpc',
 );
 
-describe.skip('RPC', () => {
-    it('should return correct block by number', async () => {
+describe('RPC', () => {
+    xit('should return correct block by number', async () => {
         let check = async (height: number) => {
             let result = await client.getBlockInfoByHeight(height);
             assert.equal(result.block?.header.height, height);
@@ -17,7 +18,7 @@ describe.skip('RPC', () => {
         }
     });
 
-    it('should return correct block by hash', async () => {
+    xit('should return correct block by hash', async () => {
         let check = async (height: number) => {
             let block_by_height = await client.getBlockInfoByHeight(height);
             let block_hash = block_by_height.block?.hash!;
@@ -29,4 +30,31 @@ describe.skip('RPC', () => {
             await check(i);
         }
     });
-});
+
+    it('should not allow to send deploy larger then 1 megabyte.', async () => {
+        // moduleBytes need to have length of (1 megabyte - 169 bytes) to produce
+        // a deploy with the size of (1 megabyte + 1 byte).
+        const oneMegaByte = 1048576;
+        const moduleBytes = Uint8Array.from(Array(oneMegaByte - 169).fill(0));
+
+        let deployParams = new DeployUtil.DeployParams(
+            Keys.Ed25519.new().publicKey, 'test');
+        let session = DeployUtil.ExecutableDeployItem.newModuleBytes(
+            moduleBytes, RuntimeArgs.fromMap({})
+        );
+        let payment = DeployUtil.standardPayment(100000);
+        let deploy = DeployUtil.makeDeploy(deployParams, session, payment);
+
+        assert.equal(DeployUtil.deploySizeInBytes(deploy), oneMegaByte + 1);
+        await client.deploy(deploy)
+            .then(_ => {
+                assert.fail("client.deploy should't throw an error.");
+            })
+            .catch(err => {
+                let expectedMessage =
+                    `Deploy can not be send, because it's too large: ${oneMegaByte + 1} bytes. ` +
+                    `Max size is 1 megabyte.`
+                assert.equal(err.message, expectedMessage);
+            });
+    });
+});