Implement typeConversion APIs bytesToHex, bigIntToString and stringToH160 (#19)

* Implement host api typeConversion.bytesToHex

* Complete host api bigIntToString.

* Create TypeId for assemblyscript loader.

* Implement host apis bigInt fromString, plus and minus

packages/graph-node/package.json

@@ -15,6 +15,7 @@
     "eslint-plugin-node": "^11.1.0",
     "eslint-plugin-promise": "^5.1.0",
     "eslint-plugin-standard": "^5.0.0",
+    "ethers": "^5.2.0",
     "nodemon": "^2.0.7",
     "ts-node": "^10.0.0",
     "typescript": "^4.3.2"

packages/graph-node/src/index.ts

@@ -4,6 +4,11 @@
 
 import fs from 'fs/promises';
 import loader from '@assemblyscript/loader';
+import { utils, BigNumber } from 'ethers';
+
+import { TypeId } from './types';
+
+type idOfType = (TypeId: number) => number
 
 export const instantiate = async (filePath: string): Promise<loader.ResultObject & { exports: any }> => {
   const buffer = await fs.readFile(filePath);
@@ -18,16 +23,16 @@ export const instantiate = async (filePath: string): Promise<loader.ResultObject
       },
 
       'typeConversion.stringToH160': () => {
-        console.log('typeConversion.stringToH160');
+        console.log('index typeConversion.stringToH160');
       },
       'typeConversion.bytesToHex': () => {
-        console.log('typeConversion.bytesToHex');
+        console.log('index typeConversion.bytesToHex');
       },
       // 'typeConversion.bytesToString': () => {
       //   console.log('typeConversion.bytesToString');
       // },
       'typeConversion.bigIntToString': () => {
-        console.log('typeConversion.bigIntToString');
+        console.log('index typeConversion.bigIntToString');
       },
 
       // 'bigDecimal.fromString': () => {
@@ -83,8 +88,136 @@ export const instantiate = async (filePath: string): Promise<loader.ResultObject
       }
     },
     conversion: {
-      'typeConversion.stringToH160': () => {
-        console.log('typeConversion.stringToH160');
+      'typeConversion.stringToH160': (s: number) => {
+        const string = __getString(s);
+        const address = utils.getAddress(string);
+        const byteArray = utils.arrayify(address);
+
+        const uint8ArrayId = getIdOfType(TypeId.Uint8Array);
+        const ptr = __newArray(uint8ArrayId, byteArray);
+
+        return ptr;
+      },
+
+      'typeConversion.bigIntToString': (bigInt: number) => {
+        const bigIntByteArray = __getArray(bigInt);
+        const bigNumber = BigNumber.from(bigIntByteArray);
+        const ptr = __newString(bigNumber.toString());
+
+        return ptr;
+      },
+      'typeConversion.bigIntToHex': () => {
+        console.log('index typeConversion.bigIntToHex');
+      },
+
+      'typeConversion.bytesToHex': (bytes: number) => {
+        const byteArray = __getArray(bytes);
+        const hexString = utils.hexlify(byteArray);
+        const ptr = __newString(hexString);
+
+        return ptr;
+      },
+      'typeConversion.bytesToString': () => {
+        console.log('index typeConversion.bytesToString');
+      },
+      'typeConversion.bytesToBase58': () => {
+        console.log('index typeConversion.bytesToBase58');
+      }
+    },
+    numbers: {
+      'bigDecimal.dividedBy': (x: number, y: number) => {
+        console.log('numbers bigDecimal.dividedBy');
+
+        const bigDecimaly = BigDecimal.wrap(y);
+
+        const yDigitsBigIntArray = __getArray(bigDecimaly.digits);
+        const yDigits = BigNumber.from(yDigitsBigIntArray);
+
+        const yExpBigIntArray = __getArray(bigDecimaly.exp);
+        const yExp = BigNumber.from(yExpBigIntArray);
+
+        console.log('y digits and exp', yDigits, yExp);
+      },
+      'bigDecimal.toString': () => {
+        console.log('numbers bigDecimal.toString');
+      },
+      'bigDecimal.fromString': () => {
+        console.log('numbers bigDecimal.toString');
+      },
+      'bigDecimal.plus': () => {
+        console.log('bigDecimal.plus');
+      },
+      'bigDecimal.minus': () => {
+        console.log('bigDecimal.minus');
+      },
+      'bigDecimal.times': () => {
+        console.log('bigDecimal.times');
+      },
+
+      'bigInt.fromString': (s: number) => {
+        const string = __getString(s);
+        const bigNumber = BigNumber.from(string);
+        const hex = bigNumber.toHexString();
+        const bytes = utils.arrayify(hex);
+
+        const uint8ArrayId = getIdOfType(TypeId.Uint8Array);
+        const ptr = __newArray(uint8ArrayId, bytes);
+        const bigInt = BigInt.fromSignedBytes(ptr);
+
+        return bigInt;
+      },
+      'bigInt.plus': (x: number, y: number) => {
+        const xBigIntArray = __getArray(x);
+        const xBigNumber = BigNumber.from(xBigIntArray);
+
+        const yBigIntArray = __getArray(y);
+        const yBigNumber = BigNumber.from(yBigIntArray);
+
+        const sum = xBigNumber.add(yBigNumber);
+        const ptr = __newString(sum.toString());
+        const sumBigInt = BigInt.fromString(ptr);
+
+        return sumBigInt;
+      },
+      'bigInt.minus': (x: number, y: number) => {
+        const xBigIntArray = __getArray(x);
+        const xBigNumber = BigNumber.from(xBigIntArray);
+
+        const yBigIntArray = __getArray(y);
+        const yBigNumber = BigNumber.from(yBigIntArray);
+
+        const diff = xBigNumber.sub(yBigNumber);
+        const ptr = __newString(diff.toString());
+        const sumBigInt = BigInt.fromString(ptr);
+
+        return sumBigInt;
+      },
+      'bigInt.dividedBy': () => {
+        console.log('bigInt.dividedBy');
+      },
+      'bigInt.times': () => {
+        console.log('bigInt.times');
+      },
+      'bigInt.dividedByDecimal': () => {
+        console.log('bigInt.dividedByDecimal');
+      },
+      'bigInt.mod': () => {
+        console.log('bigInt.mod');
+      },
+      'bigInt.bitOr': () => {
+        console.log('bigInt.bitOr');
+      },
+      'bigInt.bitAnd': () => {
+        console.log('bigInt.bitAnd');
+      },
+      'bigInt.leftShift': () => {
+        console.log('bigInt.leftShift');
+      },
+      'bigInt.rightShift': () => {
+        console.log('bigInt.rightShift');
+      },
+      'bigInt.pow': () => {
+        console.log('bigInt.pow');
       }
     }
   };
@@ -92,7 +225,11 @@ export const instantiate = async (filePath: string): Promise<loader.ResultObject
   const instance = await loader.instantiate(buffer, imports);
 
   const exports = instance.exports;
-  const { __getString } = exports;
+  const { __getString, __newString, __getArray, __newArray } = exports;
+
+  const getIdOfType: idOfType = exports.id_of_type as idOfType;
+  const BigDecimal: any = exports.BigDecimal as any;
+  const BigInt: any = exports.BigInt as any;
 
   return instance;
 };

packages/graph-node/src/numbers.test.ts

@@ -0,0 +1,54 @@
+//
+// Copyright 2021 Vulcanize, Inc.
+//
+
+import path from 'path';
+import { expect } from 'chai';
+
+import { instantiate } from './index';
+
+const EXAMPLE_WASM_FILE_PATH = '../test/subgraph/example1/build/Example1/Example1.wasm';
+
+describe('typeConversion wasm tests', () => {
+  let exports: any;
+
+  before(async () => {
+    const filePath = path.resolve(__dirname, EXAMPLE_WASM_FILE_PATH);
+    const instance = await instantiate(filePath);
+    exports = instance.exports;
+    const { _start } = exports;
+
+    // Important to call _start for built subgraphs on instantiation!
+    // TODO: Check api version https://github.com/graphprotocol/graph-node/blob/6098daa8955bdfac597cec87080af5449807e874/runtime/wasm/src/module/mod.rs#L533
+    _start();
+  });
+
+  it('should execute bigInt fromString API', () => {
+    const { testBigIntFromString, __getString } = exports;
+
+    const ptr = testBigIntFromString();
+    expect(__getString(ptr)).to.equal('123');
+  });
+
+  it('should execute bigInt plus API', () => {
+    const { testBigIntPlus, __getString } = exports;
+
+    const ptr = testBigIntPlus();
+    expect(__getString(ptr)).to.equal('200');
+  });
+
+  it('should execute bigInt minus API', () => {
+    const { testBigIntMinus, __getString } = exports;
+
+    const ptr = testBigIntMinus();
+    expect(__getString(ptr)).to.equal('100');
+  });
+
+  it('should execute bigDecimal dividedBy API', () => {
+    const { testBigDecimalDividedBy, __getString } = exports;
+
+    const ptr = testBigDecimalDividedBy();
+    expect(__getString(ptr)).to.equal('10000000000000000');
+    console.log(__getString(ptr));
+  });
+});

packages/graph-node/src/type-conversion.test.ts

@@ -0,0 +1,46 @@
+//
+// Copyright 2021 Vulcanize, Inc.
+//
+
+import path from 'path';
+import { expect } from 'chai';
+
+import { instantiate } from './index';
+
+const EXAMPLE_WASM_FILE_PATH = '../test/subgraph/example1/build/Example1/Example1.wasm';
+
+describe('typeConversion wasm tests', () => {
+  let exports: any;
+
+  before(async () => {
+    const filePath = path.resolve(__dirname, EXAMPLE_WASM_FILE_PATH);
+    const instance = await instantiate(filePath);
+    exports = instance.exports;
+    const { _start } = exports;
+
+    // Important to call _start for built subgraphs on instantiation!
+    // TODO: Check api version https://github.com/graphprotocol/graph-node/blob/6098daa8955bdfac597cec87080af5449807e874/runtime/wasm/src/module/mod.rs#L533
+    _start();
+  });
+
+  it('should execute typeConversion bytesToHex API', () => {
+    const { testBytesToHex, __getString } = exports;
+
+    const ptr = testBytesToHex();
+    expect(__getString(ptr)).to.equal('0x231a');
+  });
+
+  it('should execute typeConversion bigIntToString API', () => {
+    const { testBigIntToString, __getString } = exports;
+
+    const ptr = testBigIntToString();
+    expect(__getString(ptr)).to.equal('1000000000000000000');
+  });
+
+  it('should execute typeConversion stringToH160 API', () => {
+    const { testStringToH160, __getString } = exports;
+
+    const ptr = testStringToH160();
+    expect(__getString(ptr)).to.equal('0xafad925b5eae1e370196cba39893e858ff7257d5');
+  });
+});

packages/graph-node/src/types.ts

@@ -0,0 +1,59 @@
+//
+// Copyright 2021 Vulcanize, Inc.
+//
+
+// TypeId from https://github.com/graphprotocol/graph-ts/blob/master/global/global.ts
+export enum TypeId {
+  String = 0,
+  ArrayBuffer = 1,
+  Int8Array = 2,
+  Int16Array = 3,
+  Int32Array = 4,
+  Int64Array = 5,
+  Uint8Array = 6,
+  Uint16Array = 7,
+  Uint32Array = 8,
+  Uint64Array = 9,
+  Float32Array = 10,
+  Float64Array = 11,
+  BigDecimal = 12,
+  ArrayBool = 13,
+  ArrayUint8Array = 14,
+  ArrayEthereumValue = 15,
+  ArrayStoreValue = 16,
+  ArrayJsonValue = 17,
+  ArrayString = 18,
+  ArrayEventParam = 19,
+  ArrayTypedMapEntryStringJsonValue = 20,
+  ArrayTypedMapEntryStringStoreValue = 21,
+  SmartContractCall = 22,
+  EventParam = 23,
+  EthereumTransaction = 24,
+  EthereumBlock = 25,
+  EthereumCall = 26,
+  WrappedTypedMapStringJsonValue = 27,
+  WrappedBool = 28,
+  WrappedJsonValue = 29,
+  EthereumValue = 30,
+  StoreValue = 31,
+  JsonValue = 32,
+  EthereumEvent = 33,
+  TypedMapEntryStringStoreValue = 34,
+  TypedMapEntryStringJsonValue = 35,
+  TypedMapStringStoreValue = 36,
+  TypedMapStringJsonValue = 37,
+  TypedMapStringTypedMapStringJsonValue = 38,
+  ResultTypedMapStringJsonValueBool = 39,
+  ResultJsonValueBool = 40,
+  ArrayU8 = 41,
+  ArrayU16 = 42,
+  ArrayU32 = 43,
+  ArrayU64 = 44,
+  ArrayI8 = 45,
+  ArrayI16 = 46,
+  ArrayI32 = 47,
+  ArrayI64 = 48,
+  ArrayF32 = 49,
+  ArrayF64 = 50,
+  ArrayBigDecimal = 51,
+}

packages/graph-node/test/subgraph/example1/src/mapping.ts

@@ -1,50 +1,52 @@
-import { Address, log } from '@graphprotocol/graph-ts';
+import { Address, log, BigInt, BigDecimal, ByteArray } from '@graphprotocol/graph-ts';
 
 import {
-  Example1
+  Example1,
+  Test
 } from '../generated/Example1/Example1';
+import { ExampleEntity } from '../generated/schema';
 
-// export function handleTest (event: Test): void {
-//   // Entities can be loaded from the store using a string ID; this ID
-//   // needs to be unique across all entities of the same type
-//   let entity = ExampleEntity.load(event.transaction.from.toHex());
+export function handleTest (event: Test): void {
+  // Entities can be loaded from the store using a string ID; this ID
+  // needs to be unique across all entities of the same type
+  let entity = ExampleEntity.load(event.transaction.from.toHex());
 
-//   // Entities only exist after they have been saved to the store;
-//   // `null` checks allow to create entities on demand
-//   if (!entity) {
-//     entity = new ExampleEntity(event.transaction.from.toHex());
+  // Entities only exist after they have been saved to the store;
+  // `null` checks allow to create entities on demand
+  if (!entity) {
+    entity = new ExampleEntity(event.transaction.from.toHex());
 
-//     // Entity fields can be set using simple assignments
-//     entity.count = BigInt.fromI32(0);
-//   }
+    // Entity fields can be set using simple assignments
+    entity.count = BigInt.fromI32(0);
+  }
 
-//   // BigInt and BigDecimal math are supported
-//   // entity.count = entity.count + BigInt.fromI32(1)
+  // BigInt and BigDecimal math are supported
+  // entity.count = entity.count + BigInt.fromI32(1)
 
-//   // Entity fields can be set based on event parameters
-//   entity.param1 = event.params.param1;
-//   entity.param2 = event.params.param2;
+  // Entity fields can be set based on event parameters
+  entity.param1 = event.params.param1;
+  entity.param2 = event.params.param2;
 
-//   // Entities can be written to the store with `.save()`
-//   entity.save();
+  // Entities can be written to the store with `.save()`
+  entity.save();
 
-//   // Note: If a handler doesn't require existing field values, it is faster
-//   // _not_ to load the entity from the store. Instead, create it fresh with
-//   // `new Entity(...)`, set the fields that should be updated and save the
-//   // entity back to the store. Fields that were not set or unset remain
-//   // unchanged, allowing for partial updates to be applied.
+  // Note: If a handler doesn't require existing field values, it is faster
+  // _not_ to load the entity from the store. Instead, create it fresh with
+  // `new Entity(...)`, set the fields that should be updated and save the
+  // entity back to the store. Fields that were not set or unset remain
+  // unchanged, allowing for partial updates to be applied.
 
-//   // It is also possible to access smart contracts from mappings. For
-//   // example, the contract that has emitted the event can be connected to
-//   // with:
-//   //
-//   // let contract = Contract.bind(event.address)
-//   //
-//   // The following functions can then be called on this contract to access
-//   // state variables and other data:
-//   //
-//   // - contract.getMethod(...)
-// }
+  // It is also possible to access smart contracts from mappings. For
+  // example, the contract that has emitted the event can be connected to
+  // with:
+  //
+  // let contract = Contract.bind(event.address)
+  //
+  // The following functions can then be called on this contract to access
+  // state variables and other data:
+  //
+  // - contract.getMethod(...)
+}
 
 export function testEthCall (): void {
   log.debug('In test eth call', []);
@@ -62,3 +64,87 @@ export function testEthCall (): void {
     log.debug('Contract eth call result', []);
   }
 }
+
+export function testBytesToHex (): string {
+  log.debug('In test bytesToHex', []);
+
+  const hexString = '0x231a';
+  log.debug('Using hexString: {}', [hexString]);
+
+  const byteArray = ByteArray.fromHexString(hexString);
+  const res = byteArray.toHexString();
+  log.debug('typeConversion.bytesToHex result: {}', [res]);
+
+  return res;
+}
+
+export function testBigIntToString (): string {
+  log.debug('In test bigIntToString', []);
+
+  const bigInt = BigInt.fromString('1000000000000000000');
+  const res = bigInt.toString();
+  log.debug('typeConversion.bigIntToString from hex result: {}', [res]);
+
+  return res;
+}
+
+export function testStringToH160 (): string {
+  log.debug('In test stringToH160', []);
+
+  const addressString = '0xafad925b5eae1e370196cba39893e858ff7257d5';
+  const address = Address.fromString(addressString);
+  const res = address.toHexString();
+  log.debug('typeConversion.stringToH160 result: {}', [res]);
+
+  return res;
+}
+
+export function testBigDecimalDividedBy (): string {
+  log.debug('In test bigDecimal.dividedBy', []);
+
+  const bigInt1 = BigInt.fromString('1000000000000000000');
+  const bigInt2 = BigInt.fromString('100');
+
+  const bigDecimal1 = new BigDecimal(bigInt1);
+  const bigDecimal2 = new BigDecimal(bigInt2);
+  const res = bigDecimal1 / bigDecimal2;
+  log.debug('bigDecimal.dividedBy result: {}', [res.toString()]);
+
+  return res.toString();
+}
+
+export function testBigIntPlus (): string {
+  log.debug('In test bigInt.plus', []);
+
+  const bigInt1 = BigInt.fromString('100');
+  const bigInt2 = BigInt.fromString('100');
+
+  const res = bigInt1 + bigInt2;
+  log.debug('bigInt.plus result: {}', [res.toString()]);
+  return res.toString();
+}
+
+export function testBigIntMinus (): string {
+  log.debug('In test bigInt.minus', []);
+
+  const bigInt1 = BigInt.fromString('200');
+  const bigInt2 = BigInt.fromString('100');
+
+  const res = bigInt1 - bigInt2;
+  log.debug('bigInt.minus result: {}', [res.toString()]);
+  return res.toString();
+}
+
+export function testBigIntFromString (): string {
+  log.debug('In test bigInt.fromString', []);
+
+  const string = '123';
+  const bigInt = BigInt.fromString(string);
+  const res = bigInt.toString();
+  log.debug('bigInt.FromString result: {}', [res]);
+
+  return res;
+}
+
+// TODO: Export it automatically using graph-cli.
+export { BigDecimal, BigInt };