Merge pull request #118 from input-output-hk/feat/query-stakepools

feat: stake pool search

.eslintrc.js

@@ -23,6 +23,7 @@ module.exports = {
       2,
       "unix"
     ],
+    "new-cap": 0,
     "no-unused-expressions": 0,
     "no-useless-constructor": 0,
     "quotes": ["error", "single", { "avoidEscape": true }],
@@ -31,6 +32,8 @@ module.exports = {
     "unicorn/no-null": 0,
     "unicorn/no-array-reduce": 0,
     "unicorn/prefer-node-protocol": 0,
+    "unicorn/prefer-module": 0,
+    "unicorn/no-array-callback-reference": 0, // needed for inference from type guards
     "@typescript-eslint/no-floating-promises": ["error"],
     '@typescript-eslint/no-var-requires': 0, // covered by unicorn/prefer-module
     '@typescript-eslint/explicit-module-boundary-types': 0,

.graphqlrc.yml

@@ -0,0 +1,2 @@
+schema: 'packages/cardano-graphql/dist/dgraph.graphql'
+documents: 'packages/cardano-graphql/src/operations/**/*.graphql'

.versionrc.js

@@ -1,39 +1,43 @@
 const packageMap = [
   {
-    filename: "package.json",
-    type: "json"
+    filename: 'package.json',
+    type: 'json'
   },
   {
-    filename: "packages/blockfrost/package.json",
-    type: "json"
+    filename: 'packages/blockfrost/package.json',
+    type: 'json'
   },
   {
-    filename: "packages/cardano-graphql-db-sync/package.json",
-    type: "json"
+    filename: 'packages/cardano-graphql/package.json',
+    type: 'json'
   },
   {
-    filename: "packages/cip2/package.json",
-    type: "json"
+    filename: 'packages/cardano-graphql-db-sync/package.json',
+    type: 'json'
   },
   {
-    filename: "packages/cip30/package.json",
-    type: "json"
+    filename: 'packages/cip2/package.json',
+    type: 'json'
   },
   {
-    filename: "packages/core/package.json",
-    type: "json"
+    filename: 'packages/cip30/package.json',
+    type: 'json'
   },
   {
-    filename: "packages/golden-test-generator/package.json",
-    type: "json"
+    filename: 'packages/core/package.json',
+    type: 'json'
   },
   {
-    filename: "packages/util-dev/package.json",
-    type: "json"
+    filename: 'packages/golden-test-generator/package.json',
+    type: 'json'
   },
   {
-    filename: "packages/wallet/package.json",
-    type: "json"
+    filename: 'packages/util-dev/package.json',
+    type: 'json'
+  },
+  {
+    filename: 'packages/wallet/package.json',
+    type: 'json'
   }
 ];
 
@@ -44,5 +48,5 @@ module.exports = {
     commit: true,
     tag: true
   },
-  "tag-prefix": ""
-}
+  'tag-prefix': ''
+};

README.md

@@ -23,6 +23,7 @@ A suite of TypeScript packages suitable for both Node.js and browser-based devel
 ### Cardano Provider Implementations
 
 - [@cardano-sdk/cardano-graphql-db-sync](packages/cardano-graphql-db-sync)
+- [@cardano-sdk/cardano-graphql](packages/cardano-graphql)
 - [@cardano-sdk/blockfrost](packages/blockfrost)
 
 :information_source: Looking to use a Cardano service not listed here? [Let us know!]
@@ -35,11 +36,13 @@ You may use the following config when bundling this SDK with Webpack:
 const { IgnorePlugin, ProvidePlugin } = require('webpack');
 {
   plugins: [
-    // see https://www.npmjs.com/package/isomorphic-bip39 README
+    // see https://www.npmjs.com/package/bip39 README
     new IgnorePlugin(/^\.\/wordlists\/(?!english)/, /bip39\/src$/),
   ],
   experiments: {
-    asyncWebAssembly: true
+    // Requires code splitting to work.
+    // Must dynamically `import()` a chunk that imports '@cardano-sdk/*'.
+    syncWebAssembly: true
   }
 }
 ```
@@ -51,8 +54,9 @@ const { NormalModuleReplacementPlugin } = require('webpack');
 {
   resolve: {
     fallback: {
-      // May want to install readable-stream as an explicit dependency
+      // Node.js polyfills. May want to install as explicit dependencies.
       stream: require.resolve('readable-stream'),
+      buffer: require.resolve('buffer'),
     }
   },
   plugins: [

packages/blockfrost/src/blockfrostProvider.ts

@@ -1,5 +1,5 @@
 /* eslint-disable @typescript-eslint/no-explicit-any */
-import { CardanoProvider, ProviderError, ProviderFailure } from '@cardano-sdk/core';
+import { WalletProvider, ProviderError, ProviderFailure } from '@cardano-sdk/core';
 import { BlockFrostAPI, Error as BlockfrostError } from '@blockfrost/blockfrost-js';
 import { Options } from '@blockfrost/blockfrost-js/lib/types';
 import { BlockfrostToOgmios } from './BlockfrostToOgmios';
@@ -51,17 +51,17 @@ const toProviderError = (error: unknown) => {
  * Connect to the [Blockfrost service](https://docs.blockfrost.io/)
  *
  * @param {Options} options BlockFrostAPI options
- * @returns {CardanoProvider} CardanoProvider
+ * @returns {WalletProvider} WalletProvider
  */
-export const blockfrostProvider = (options: Options): CardanoProvider => {
+export const blockfrostProvider = (options: Options): WalletProvider => {
   const blockfrost = new BlockFrostAPI(options);
 
-  const ledgerTip: CardanoProvider['ledgerTip'] = async () => {
+  const ledgerTip: WalletProvider['ledgerTip'] = async () => {
     const block = await blockfrost.blocksLatest();
     return BlockfrostToOgmios.blockToTip(block);
   };
 
-  const networkInfo: CardanoProvider['networkInfo'] = async () => {
+  const networkInfo: WalletProvider['networkInfo'] = async () => {
     const currentEpoch = await blockfrost.epochsLatest();
     const { stake, supply } = await blockfrost.network();
     return {
@@ -86,7 +86,7 @@ export const blockfrostProvider = (options: Options): CardanoProvider => {
     };
   };
 
-  const stakePoolStats: CardanoProvider['stakePoolStats'] = async () => {
+  const stakePoolStats: WalletProvider['stakePoolStats'] = async () => {
     const tallyPools = async (query: 'pools' | 'poolsRetired' | 'poolsRetiring', count = 0, page = 1) => {
       const result = await blockfrost[query]({ page });
       const newCount = count + result.length;
@@ -104,11 +104,11 @@ export const blockfrostProvider = (options: Options): CardanoProvider => {
     };
   };
 
-  const submitTx: CardanoProvider['submitTx'] = async (signedTransaction) => {
+  const submitTx: WalletProvider['submitTx'] = async (signedTransaction) => {
     await blockfrost.txSubmit(signedTransaction.to_bytes());
   };
 
-  const utxoDelegationAndRewards: CardanoProvider['utxoDelegationAndRewards'] = async (addresses, stakeKeyHash) => {
+  const utxoDelegationAndRewards: WalletProvider['utxoDelegationAndRewards'] = async (addresses, stakeKeyHash) => {
     const utxoResults = await Promise.all(
       addresses.map(async (address) =>
         blockfrost.addressesUtxosAll(address).then((result) => BlockfrostToOgmios.addressUtxoContent(address, result))
@@ -125,35 +125,34 @@ export const blockfrostProvider = (options: Options): CardanoProvider => {
     return { utxo, delegationAndRewards };
   };
 
-  const queryTransactionsByAddresses: CardanoProvider['queryTransactionsByAddresses'] = async (addresses) => {
+  const queryTransactionsByHashes: WalletProvider['queryTransactionsByHashes'] = async (hashes) => {
+    const transactions = await Promise.all(hashes.map(async (hash) => blockfrost.txsUtxos(hash)));
+    return transactions.map((tx) => BlockfrostToOgmios.txContentUtxo(tx));
+  };
+
+  const queryTransactionsByAddresses: WalletProvider['queryTransactionsByAddresses'] = async (addresses) => {
     const addressTransactions = await Promise.all(
       addresses.map(async (address) => blockfrost.addressesTransactionsAll(address))
     );
 
     const transactionsArray = await Promise.all(
       addressTransactions.map((transactionArray) =>
-        Promise.all(transactionArray.map(async ({ tx_hash }) => blockfrost.txsUtxos(tx_hash)))
+        queryTransactionsByHashes(transactionArray.map(({ tx_hash }) => tx_hash))
       )
     );
 
-    return transactionsArray.flat(1).map((tx) => BlockfrostToOgmios.txContentUtxo(tx));
-  };
-
-  const queryTransactionsByHashes: CardanoProvider['queryTransactionsByHashes'] = async (hashes) => {
-    const transactions = await Promise.all(hashes.map(async (hash) => blockfrost.txsUtxos(hash)));
-
-    return transactions.map((tx) => BlockfrostToOgmios.txContentUtxo(tx));
+    return transactionsArray.flat(1);
   };
 
-  const currentWalletProtocolParameters: CardanoProvider['currentWalletProtocolParameters'] = async () => {
+  const currentWalletProtocolParameters: WalletProvider['currentWalletProtocolParameters'] = async () => {
     const response = await blockfrost.axiosInstance({
       url: `${blockfrost.apiUrl}/epochs/latest/parameters`
     });
 
     return BlockfrostToOgmios.currentWalletProtocolParameters(response.data);
   };
 
-  const providerFunctions = {
+  const providerFunctions: WalletProvider = {
     ledgerTip,
     networkInfo,
     stakePoolStats,
@@ -162,10 +161,10 @@ export const blockfrostProvider = (options: Options): CardanoProvider => {
     queryTransactionsByAddresses,
     queryTransactionsByHashes,
     currentWalletProtocolParameters
-  } as any;
+  };
 
   return Object.keys(providerFunctions).reduce((provider, key) => {
-    provider[key] = (...args: any[]) => providerFunctions[key](...args).catch(toProviderError);
+    provider[key] = (...args: any[]) => (providerFunctions as any)[key](...args).catch(toProviderError);
     return provider;
-  }, {} as any) as CardanoProvider;
+  }, {} as any) as WalletProvider;
 };

packages/blockfrost/src/index.ts

@@ -1,3 +1,3 @@
-export { CardanoProvider } from '@cardano-sdk/core';
+export { WalletProvider } from '@cardano-sdk/core';
 export * from './blockfrostProvider';
 export { Options } from '@blockfrost/blockfrost-js/lib/types';

packages/cardano-graphql-db-sync/src/cardanoGraphqlDbSyncProvider.ts

@@ -1,4 +1,4 @@
-import { CardanoProvider, ProviderError, ProviderFailure } from '@cardano-sdk/core';
+import { WalletProvider, ProviderError, ProviderFailure } from '@cardano-sdk/core';
 import { gql, GraphQLClient } from 'graphql-request';
 import { TransactionSubmitResponse } from '@cardano-graphql/client-ts';
 import { Schema as Cardano } from '@cardano-ogmios/client';
@@ -16,10 +16,10 @@ import {
  * ```
  */
 
-export const cardanoGraphqlDbSyncProvider = (uri: string): CardanoProvider => {
+export const cardanoGraphqlDbSyncProvider = (uri: string): WalletProvider => {
   const client = new GraphQLClient(uri);
 
-  const ledgerTip: CardanoProvider['ledgerTip'] = async () => {
+  const ledgerTip: WalletProvider['ledgerTip'] = async () => {
     const query = gql`
       query {
         cardano {
@@ -43,7 +43,7 @@ export const cardanoGraphqlDbSyncProvider = (uri: string): CardanoProvider => {
     return CardanoGraphqlToOgmios.tip(response.cardano.tip);
   };
 
-  const networkInfo: CardanoProvider['networkInfo'] = async () => {
+  const networkInfo: WalletProvider['networkInfo'] = async () => {
     const query = gql`
       query {
         activeStake_aggregate {
@@ -118,7 +118,7 @@ export const cardanoGraphqlDbSyncProvider = (uri: string): CardanoProvider => {
     };
   };
 
-  const stakePoolStats: CardanoProvider['stakePoolStats'] = async () => {
+  const stakePoolStats: WalletProvider['stakePoolStats'] = async () => {
     const currentEpochResponse = await client.request<{
       cardano: {
         currentEpoch: {
@@ -207,7 +207,7 @@ export const cardanoGraphqlDbSyncProvider = (uri: string): CardanoProvider => {
     };
   };
 
-  const submitTx: CardanoProvider['submitTx'] = async (signedTransaction) => {
+  const submitTx: WalletProvider['submitTx'] = async (signedTransaction) => {
     try {
       const mutation = gql`
         mutation ($transaction: String!) {
@@ -233,11 +233,11 @@ export const cardanoGraphqlDbSyncProvider = (uri: string): CardanoProvider => {
   };
 
   // eslint-disable-next-line unicorn/consistent-function-scoping
-  const utxoDelegationAndRewards: CardanoProvider['utxoDelegationAndRewards'] = async () => {
+  const utxoDelegationAndRewards: WalletProvider['utxoDelegationAndRewards'] = async () => {
     throw new Error('Not implemented yet.');
   };
 
-  const queryTransactionsByAddresses: CardanoProvider['queryTransactionsByAddresses'] = async (addresses) => {
+  const queryTransactionsByAddresses: WalletProvider['queryTransactionsByAddresses'] = async (addresses) => {
     const query = gql`
       query ($addresses: [String]!) {
         transactions(
@@ -280,7 +280,7 @@ export const cardanoGraphqlDbSyncProvider = (uri: string): CardanoProvider => {
     return CardanoGraphqlToOgmios.graphqlTransactionsToCardanoTxs(response.transactions);
   };
 
-  const queryTransactionsByHashes: CardanoProvider['queryTransactionsByHashes'] = async (hashes) => {
+  const queryTransactionsByHashes: WalletProvider['queryTransactionsByHashes'] = async (hashes) => {
     const query = gql`
       query ($hashes: [Hash32Hex]!) {
         transactions(where: { hash: { _in: $hashes } }) {
@@ -321,7 +321,7 @@ export const cardanoGraphqlDbSyncProvider = (uri: string): CardanoProvider => {
     return CardanoGraphqlToOgmios.graphqlTransactionsToCardanoTxs(response.transactions);
   };
 
-  const currentWalletProtocolParameters: CardanoProvider['currentWalletProtocolParameters'] = async () => {
+  const currentWalletProtocolParameters: WalletProvider['currentWalletProtocolParameters'] = async () => {
     const query = gql`
       query {
         cardano {

packages/cardano-graphql-db-sync/src/index.ts

@@ -1,2 +1,2 @@
-export { CardanoProvider } from '@cardano-sdk/core';
+export { WalletProvider } from '@cardano-sdk/core';
 export * from './cardanoGraphqlDbSyncProvider';

packages/cardano-graphql/.gitignore

@@ -0,0 +1,4 @@
+node_modules
+dist
+secrets
+coverage

packages/cardano-graphql/.graphqlrc.yml

@@ -0,0 +1,2 @@
+schema: 'dist/schema.graphql'
+documents: 'src/operations/*.graphql'

packages/cardano-graphql/README.md

@@ -0,0 +1,17 @@
+# Cardano JS SDK | Cardano GraphQL
+
+This package implements StakePoolSearchProvider using GraphQL
+
+## Server-side usage
+
+This package:
+
+1. Generates GraphQL SDL schema from TypeScript types (`yarn build:schema`, also part of `yarn build`) `=> dist/schema.graphql`
+2. Generates Dgraph schema (`yarn build:schema:dgraph`; requires local dgraph server running at port 8080, see [docker-compose.yml](./docker-compose.yml)) `=> dist/dgraph.graphql`
+3. Generates [dgraph client](./src/sdk.ts) from Dgraph schema and [operations](./src/operations), which can then be used to implement `*Provider` interfaces (`yarn generate`)
+
+## Tests
+
+See [code coverage report]
+
+[code coverage report]: https://input-output-hk.github.io/cardano-js-sdk/coverage/cardano-graphql

packages/cardano-graphql/codegen.yml

@@ -0,0 +1,13 @@
+schema: ./dist/dgraph.graphql
+documents: ./src/operations/*.graphql
+generates:
+  ./src/sdk.ts:
+    plugins:
+      - typescript
+      - typescript-operations
+      - typescript-graphql-request
+config:
+  strictScalars: true
+  scalars:
+    DateTime: string
+    Int64: number

packages/cardano-graphql/docker-compose.yml

@@ -0,0 +1,10 @@
+version: "3.5"
+services:
+  dgraph:
+    image: dgraph/standalone:v21.03.0
+    ports:
+      - 8080:8080
+    volumes:
+      - dgraph:/dgraph
+volumes:
+  dgraph:

packages/cardano-graphql/jest.config.js

@@ -0,0 +1 @@
+module.exports = require('../../test/jest.config');