fix: json formatting and deploy

starknet-io · Oct 23, 2021 · 0fe7e3d · 0fe7e3d
1 parent 3665897
commit 0fe7e3d
Show file tree

Hide file tree

Showing 9 changed files with 106 additions and 17 deletions.
diff --git a/__tests__/__snapshots__/utils.browser.test.ts.snap b/__tests__/__snapshots__/utils.browser.test.ts.snap
diff --git a/__tests__/__snapshots__/utils.test.ts.snap b/__tests__/__snapshots__/utils.test.ts.snap
diff --git a/__tests__/index.test.ts b/__tests__/index.test.ts
@@ -1,5 +1,15 @@
-import starknet, { CompiledContract, compressProgram, randomAddress, makeAddress } from '..';
-import compiledArgentAccount from '../__mocks__/ArgentAccount.json';
+import fs from 'fs';
+import starknet, {
+  CompiledContract,
+  compressProgram,
+  randomAddress,
+  makeAddress,
+  JsonParser,
+} from '..';
+
+const compiledArgentAccount = JsonParser.parse(
+  fs.readFileSync('./__mocks__/ArgentAccount.json').toString('ascii')
+);
 
 describe('starknet endpoints', () => {
   describe('feeder gateway endpoints', () => {

diff --git a/__tests__/utils.browser.test.ts b/__tests__/utils.browser.test.ts
@@ -2,8 +2,12 @@
  * @jest-environment jsdom
  */
 
-import { compressProgram, isBrowser } from '..';
-import compiledArgentAccount from '../__mocks__/ArgentAccount.json';
+import fs from 'fs';
+import { compressProgram, isBrowser, JsonParser } from '..';
+
+const compiledArgentAccount = JsonParser.parse(
+  fs.readFileSync('./__mocks__/ArgentAccount.json').toString('ascii')
+);
 
 test('isBrowser', () => {
   expect(isBrowser).toBe(true);
@@ -14,6 +18,13 @@ describe('compressProgram()', () => {
 
     const compressed = compressProgram(inputContract.program);
 
+    expect(compressed).toMatchSnapshot();
+  });
+  test('works with strings', () => {
+    const inputProgram = JsonParser.stringify(compiledArgentAccount.program);
+
+    const compressed = compressProgram(inputProgram);
+
     expect(compressed).toMatchSnapshot();
   });
 });
diff --git a/__tests__/utils.test.ts b/__tests__/utils.test.ts
@@ -1,18 +1,28 @@
-import { compressProgram, makeAddress, isBrowser } from '..';
-import compiledArgentAccount from '../__mocks__/ArgentAccount.json';
+import fs from 'fs';
+import { compressProgram, makeAddress, isBrowser, JsonParser } from '..';
+
+const compiledArgentAccount = JsonParser.parse(
+  fs.readFileSync('./__mocks__/ArgentAccount.json').toString('ascii')
+);
 
 test('isNode', () => {
   expect(isBrowser).toBe(false);
 });
 describe('compressProgram()', () => {
   test('compresses a contract program', () => {
-    const inputContract = compiledArgentAccount as any;
+    const inputProgram = compiledArgentAccount.program;
+
+    const compressed = compressProgram(inputProgram);
+
+    expect(compressed).toMatchSnapshot();
+  });
+  test('works with strings', () => {
+    const inputProgram = JsonParser.stringify(compiledArgentAccount.program);
 
-    const compressed = compressProgram(inputContract.program);
+    const compressed = compressProgram(inputProgram);
 
     expect(compressed).toMatchSnapshot();
   });
-  // there's basically no error case with almost all types being supported
 });
 describe('makeAddress()', () => {
   test('test on eth address', () => {

diff --git a/package-lock.json b/package-lock.json
diff --git a/package.json b/package.json
@@ -36,6 +36,7 @@
     "@semantic-release/npm": "^8.0.2",
     "@semantic-release/release-notes-generator": "^10.0.2",
     "@types/jest": "^27.0.2",
+    "@types/json-bigint": "^1.0.1",
     "@types/pako": "^1.0.2",
     "@typescript-eslint/eslint-plugin": "^5.0.0",
     "@typescript-eslint/parser": "^5.0.0",
@@ -54,6 +55,7 @@
   },
   "dependencies": {
     "axios": "^0.23.0",
+    "json-bigint": "^1.0.0",
     "pako": "^2.0.4"
   },
   "lint-staged": {

diff --git a/src/index.ts b/src/index.ts
@@ -1,5 +1,5 @@
 import axios from 'axios';
-import { randomAddress, compressProgram } from './utils';
+import { randomAddress, compressProgram, JsonParser } from './utils';
 import type {
   GetBlockResponse,
   GetCode,
@@ -189,12 +189,14 @@ export function addTransaction(tx: Transaction): Promise<AddTransactionResponse>
  * @returns a confirmation of sending a transaction on the starknet contract
  */
 export function deployContract(
-  contract: CompiledContract,
+  contract: CompiledContract | string,
   address: string = randomAddress()
 ): Promise<AddTransactionResponse> {
+  const parsedContract =
+    typeof contract === 'string' ? (JsonParser.parse(contract) as CompiledContract) : contract;
   const contractDefinition = {
-    ...contract,
-    program: compressProgram(contract.program),
+    ...parsedContract,
+    program: compressProgram(parsedContract.program),
   };
 
   return addTransaction({

diff --git a/src/utils.ts b/src/utils.ts
@@ -1,4 +1,5 @@
 import { gzip } from 'pako';
+import Json from 'json-bigint';
 import { CompressedProgram, Program } from './types';
 import { CONTRACT_ADDRESS_LOWER_BOUND, CONTRACT_ADDRESS_UPPER_BOUND } from './constants';
 
@@ -22,15 +23,21 @@ export function makeAddress(input: string): string {
   return `0x${input.replace(/^0x/, '').toLowerCase()}`;
 }
 
+export const JsonParser = Json({
+  alwaysParseAsBig: true,
+  useNativeBigInt: true,
+});
+
 /**
  * Function to compress compiled cairo program
  *
  * [Reference](https://github.com/starkware-libs/cairo-lang/blob/master/src/starkware/starknet/services/api/gateway/transaction.py#L54-L58)
  * @param jsonProgram - json file representing the compiled cairo program
  * @returns Compressed cairo program
  */
-export function compressProgram(jsonProgram: Program): CompressedProgram {
-  const stringified = JSON.stringify(jsonProgram);
+export function compressProgram(jsonProgram: Program | string): CompressedProgram {
+  const stringified =
+    typeof jsonProgram === 'string' ? jsonProgram : JsonParser.stringify(jsonProgram);
   const compressedProgram = gzip(stringified);
   const base64 = btoaUniversal(compressedProgram);
   return base64;