Merge pull request #23 from seanjameshan/feature/allow-invokeFunction-transactions

feat: enable invokeFunction transactions

Author: 0xs34n

.eslintrc

@@ -5,7 +5,7 @@
     "node": true,
     "jest": true
   },
-  "extends": ["airbnb-base", "airbnb-typescript/base", "prettier", "plugin:prettier/recommended", ],
+  "extends": ["airbnb-base", "airbnb-typescript/base", "prettier", "plugin:prettier/recommended"],
   "globals": {
     "Atomics": "readonly",
     "SharedArrayBuffer": "readonly"
@@ -16,5 +16,9 @@
     "sourceType": "module",
     "project": "./tsconfig.eslint.json"
   },
-  "plugins": ["@typescript-eslint"]
+  "plugins": ["@typescript-eslint"],
+  "rules": {
+    "import/prefer-default-export": 0,
+    "@typescript-eslint/naming-convention": 0
+  }
 }

__mocks__/ERC20.json

@@ -0,0 +1,53 @@
+import { BigNumber } from '@ethersproject/bignumber';
+import fs from 'fs';
+import {
+  CompiledContract,
+  Contract,
+  deployContract,
+  JsonParser,
+  randomAddress,
+  waitForTx,
+} from '../src';
+
+const compiledERC20: CompiledContract = JsonParser.parse(
+  fs.readFileSync('./__mocks__/ERC20.json').toString('ascii')
+);
+
+describe('class Contract {}', () => {
+  const address = randomAddress();
+  const wallet = randomAddress();
+  const contract = new Contract(compiledERC20.abi, address);
+  beforeAll(async () => {
+    const { code, tx_id } = await deployContract(compiledERC20, address);
+    // I want to show the tx number to the tester, so he/she can trace the transaction in the explorer.
+    // eslint-disable-next-line no-console
+    console.log('deployed erc20 contract', tx_id);
+    expect(code).toBe('TRANSACTION_RECEIVED');
+    await waitForTx(tx_id);
+  });
+  test('read initial balance of that account', async () => {
+    const response = await contract.call('balance_of', {
+      user: wallet,
+    });
+    expect(BigNumber.from(response.res)).toStrictEqual(BigNumber.from(0));
+  });
+  test('add 10 test ERC20 to account', async () => {
+    const response = await contract.invoke('mint', {
+      recipient: wallet,
+      amount: '10',
+    });
+    expect(response.code).toBe('TRANSACTION_RECEIVED');
+
+    // I want to show the tx number to the tester, so he/she can trace the transaction in the explorer.
+    // eslint-disable-next-line no-console
+    console.log('txId:', response.tx_id, ', funded wallet:', wallet);
+    await waitForTx(response.tx_id);
+  });
+  test('read balance after mint of that account', async () => {
+    const response = await contract.call('balance_of', {
+      user: wallet,
+    });
+
+    expect(BigNumber.from(response.res)).toStrictEqual(BigNumber.from(10));
+  });
+});

__tests__/contracts.test.ts

@@ -1,7 +1,18 @@
 import fs from 'fs';
-import { compressProgram, randomAddress, makeAddress, JsonParser } from '../src/utils';
-import { CompiledContract } from '../src/types';
-import * as starknet from '../src/index';
+import {
+  CompiledContract,
+  compressProgram,
+  randomAddress,
+  JsonParser,
+  getContractAddresses,
+  getBlock,
+  getCode,
+  getStorageAt,
+  getTransactionStatus,
+  getTransaction,
+  addTransaction,
+  deployContract,
+} from '../src';
 
 const compiledArgentAccount = JsonParser.parse(
   fs.readFileSync('./__mocks__/ArgentAccount.json').toString('ascii')
@@ -10,31 +21,27 @@ const compiledArgentAccount = JsonParser.parse(
 describe('starknet endpoints', () => {
   describe('feeder gateway endpoints', () => {
     test('getContractAddresses()', () => {
-      return expect(starknet.getContractAddresses()).resolves.not.toThrow();
+      return expect(getContractAddresses()).resolves.not.toThrow();
     });
     xtest('callContract()', () => {});
     test('getBlock()', () => {
-      return expect(starknet.getBlock(46500)).resolves.not.toThrow();
+      return expect(getBlock(46500)).resolves.not.toThrow();
     });
     test('getCode()', () => {
       return expect(
-        starknet.getCode('0x5f778a983bf8760ad37868f4c869d70247c5546044a7f0386df96d8043d4e9d', 46500)
+        getCode('0x5f778a983bf8760ad37868f4c869d70247c5546044a7f0386df96d8043d4e9d', 46500)
       ).resolves.not.toThrow();
     });
     test('getStorageAt()', () => {
       return expect(
-        starknet.getStorageAt(
-          '0x5f778a983bf8760ad37868f4c869d70247c5546044a7f0386df96d8043d4e9d',
-          0,
-          46500
-        )
+        getStorageAt('0x5f778a983bf8760ad37868f4c869d70247c5546044a7f0386df96d8043d4e9d', 0, 46500)
       ).resolves.not.toThrow();
     });
     test('getTransactionStatus()', () => {
-      return expect(starknet.getTransactionStatus(286136)).resolves.not.toThrow();
+      return expect(getTransactionStatus(286136)).resolves.not.toThrow();
     });
     test('getTransaction()', () => {
-      return expect(starknet.getTransaction(286136)).resolves.not.toThrow();
+      return expect(getTransaction(286136)).resolves.not.toThrow();
     });
   });
 
@@ -47,7 +54,7 @@ describe('starknet endpoints', () => {
         program: compressProgram(inputContract.program),
       };
 
-      const response = await starknet.addTransaction({
+      const response = await addTransaction({
         type: 'DEPLOY',
         contract_address: randomAddress(),
         contract_definition: contractDefinition,
@@ -59,15 +66,11 @@ describe('starknet endpoints', () => {
       // eslint-disable-next-line no-console
       console.log('txId:', response.tx_id);
     });
-    xtest('type: "INVOKE_FUNCTION"', () => {});
 
     test('deployContract()', async () => {
       const inputContract = compiledArgentAccount as unknown as CompiledContract;
 
-      const response = await starknet.deployContract(
-        inputContract,
-        makeAddress('0x20b5B1b8aFd65F1FCB755a449000cFC4aBCA0D40')
-      );
+      const response = await deployContract(inputContract);
       expect(response.code).toBe('TRANSACTION_RECEIVED');
       expect(response.tx_id).toBeGreaterThan(0);
 

__tests__/index.test.ts

@@ -3,7 +3,7 @@
  */
 
 import fs from 'fs';
-import { compressProgram, isBrowser, JsonParser } from '../src/utils';
+import { compressProgram, isBrowser, JsonParser } from '../src';
 
 const compiledArgentAccount = JsonParser.parse(
   fs.readFileSync('./__mocks__/ArgentAccount.json').toString('ascii')

__tests__/utils.browser.test.ts

@@ -1,5 +1,5 @@
 import fs from 'fs';
-import { compressProgram, makeAddress, isBrowser, JsonParser } from '../src/utils';
+import { compressProgram, makeAddress, isBrowser, JsonParser, getSelectorFromName } from '../src';
 
 const compiledArgentAccount = JsonParser.parse(
   fs.readFileSync('./__mocks__/ArgentAccount.json').toString('ascii')
@@ -33,3 +33,20 @@ describe('makeAddress()', () => {
     expect(starkAddress).toBe('0xdfd0f27fce99b50909de0bdd328aed6eabe76bc5');
   });
 });
+describe('starknetKeccak()', () => {
+  test('hash works for value="test"', () => {
+    expect(getSelectorFromName('test')).toBe(
+      '0x22ff5f21f0b81b113e63f7db6da94fedef11b2119b4088b89664fb9a3cb658'
+    );
+  });
+  test('hash works for value="initialize"', () => {
+    expect(getSelectorFromName('initialize')).toBe(
+      '0x79dc0da7c54b95f10aa182ad0a46400db63156920adb65eca2654c0945a463'
+    );
+  });
+  test('hash works for value="mint"', () => {
+    expect(getSelectorFromName('mint')).toBe(
+      '0x02f0b3c5710379609eb5495f1ecd348cb28167711b73609fe565a72734550354'
+    );
+  });
+});