Merge pull request #2 from decentraland/feat/add-blockchain-types

feat: add network and chain types

api-extractor.json

@@ -96,7 +96,7 @@
      *
      * DEFAULT VALUE: false
      */
-    "skipLibCheck": true,
+    "skipLibCheck": true
   },
   /**
    * Configures how the API report file (*.api.md) will be generated.
@@ -129,7 +129,7 @@
      * SUPPORTED TOKENS: <projectFolder>, <packageName>, <unscopedPackageName>
      * DEFAULT VALUE: "<projectFolder>/etc/"
      */
-    "reportFolder": "<projectFolder>/report/",
+    "reportFolder": "<projectFolder>/report/"
     /**
      * Specifies the folder where the temporary report file is written.  The file name portion is determined by
      * the "reportFileName" setting.

report/schemas.api.md

@@ -16,6 +16,32 @@ export type AbstractTypedSchema<T> = {
 
 export { Ajv }
 
+// @alpha
+export enum ChainId {
+    // (undocumented)
+    ETHEREUM_GOERLI = 5,
+    // (undocumented)
+    ETHEREUM_KOVAN = 42,
+    // (undocumented)
+    ETHEREUM_MAINNET = 1,
+    // (undocumented)
+    ETHEREUM_RINKEBY = 4,
+    // (undocumented)
+    ETHEREUM_ROPSTEN = 3,
+    // (undocumented)
+    MATIC_MAINNET = 89,
+    // (undocumented)
+    MATIC_MUMBAI = 13881
+}
+
+// @alpha (undocumented)
+export namespace ChainId {
+    const // (undocumented)
+    schema: JSONSchema<ChainId>;
+    const // (undocumented)
+    validate: ValidateFunction<ChainId>;
+}
+
 // @public
 export function generateValidator<T>(schema: JSONSchema<T>): ValidateFunction<T>;
 
@@ -36,6 +62,22 @@ export namespace MetaTransaction {
     validate: ValidateFunction<MetaTransaction>;
 }
 
+// @alpha
+export enum Network {
+    // (undocumented)
+    ETHEREUM = "ETHEREUM",
+    // (undocumented)
+    MATIC = "MATIC"
+}
+
+// @alpha (undocumented)
+export namespace Network {
+    const // (undocumented)
+    schema: JSONSchema<Network>;
+    const // (undocumented)
+    validate: ValidateFunction<Network>;
+}
+
 export { ValidateFunction }
 
 // @public

src/dapps/chain-id.ts

@@ -0,0 +1,27 @@
+import { generateValidator, JSONSchema, ValidateFunction } from '../validation'
+
+/**
+ * Different supported chain ids
+ * @alpha
+ */
+export enum ChainId {
+  ETHEREUM_MAINNET = 1,
+  ETHEREUM_ROPSTEN = 3,
+  ETHEREUM_RINKEBY = 4,
+  ETHEREUM_GOERLI = 5,
+  ETHEREUM_KOVAN = 42,
+  MATIC_MAINNET = 89,
+  MATIC_MUMBAI = 13881,
+}
+
+/**
+ * @alpha
+ */
+export namespace ChainId {
+  export const schema: JSONSchema<ChainId> = {
+    type: 'number',
+    enum: Object.values(ChainId),
+  }
+
+  export const validate: ValidateFunction<ChainId> = generateValidator(schema)
+}

src/dapps/meta-transactions.ts

@@ -1,4 +1,4 @@
-import { generateValidator, JSONSchema, ValidateFunction } from "../validation"
+import { generateValidator, JSONSchema, ValidateFunction } from '../validation'
 
 /**
  * Meta-transaction to be relayed
@@ -14,19 +14,21 @@ export type MetaTransaction = {
  */
 export namespace MetaTransaction {
   export const schema: JSONSchema<MetaTransaction> = {
-    type: "object",
+    type: 'object',
     properties: {
-      from: { type: "string" },
+      from: { type: 'string' },
       params: {
-        type: "array",
-        items: [{ type: "string" }, { type: "string" }],
+        type: 'array',
+        items: [{ type: 'string' }, { type: 'string' }],
         additionalItems: false,
         minItems: 2,
       },
     },
     additionalProperties: false,
-    required: ["from", "params"],
+    required: ['from', 'params'],
   }
 
-  export const validate: ValidateFunction<MetaTransaction> = generateValidator(schema)
+  export const validate: ValidateFunction<MetaTransaction> = generateValidator(
+    schema
+  )
 }

src/dapps/network.ts

@@ -0,0 +1,22 @@
+import { generateValidator, JSONSchema, ValidateFunction } from '../validation'
+
+/**
+ * Different supported networks
+ * @alpha
+ */
+export enum Network {
+  ETHEREUM = 'ETHEREUM',
+  MATIC = 'MATIC',
+}
+
+/**
+ * @alpha
+ */
+export namespace Network {
+  export const schema: JSONSchema<Network> = {
+    type: 'string',
+    enum: Object.values(Network),
+  }
+
+  export const validate: ValidateFunction<Network> = generateValidator(schema)
+}

src/index.ts

@@ -1,5 +1,7 @@
 // export the utils
-export * from "./validation"
+export * from './validation'
 
 // export all the types
-export { MetaTransaction } from "./dapps/meta-transactions"
+export { ChainId } from './dapps/chain-id'
+export { Network } from './dapps/network'
+export { MetaTransaction } from './dapps/meta-transactions'

test/chain-id.spec.ts

@@ -0,0 +1,15 @@
+import expect from 'expect'
+import { ChainId } from '../src'
+import { testTypeSignature } from './test-utils'
+
+describe('ChainId tests', () => {
+  const chainId: ChainId = ChainId.ETHEREUM_KOVAN
+
+  testTypeSignature(ChainId, chainId)
+
+  it('static tests must pass', () => {
+    expect(ChainId.validate(chainId)).toEqual(true)
+    expect(ChainId.validate(null)).toEqual(false)
+    expect(ChainId.validate({})).toEqual(false)
+  })
+})

test/network.spec.ts

@@ -0,0 +1,15 @@
+import expect from 'expect'
+import { Network } from '../src'
+import { testTypeSignature } from './test-utils'
+
+describe('Network tests', () => {
+  const network: Network = Network.ETHEREUM
+
+  testTypeSignature(Network, network)
+
+  it('static tests must pass', () => {
+    expect(Network.validate(network)).toEqual(true)
+    expect(Network.validate(null)).toEqual(false)
+    expect(Network.validate({})).toEqual(false)
+  })
+})