Merge pull request #100 from kaleido-io/1.1-validation

Add block number to tokens pools/custom contract listeners + better 1.1 support

server/src/controllers/common.ts

@@ -1,4 +1,4 @@
-import { Get, JsonController, Param, QueryParam } from 'routing-controllers';
+import { Get, InternalServerError, JsonController, Param, QueryParam } from 'routing-controllers';
 import { OpenAPI, ResponseSchema } from 'routing-controllers-openapi';
 import { firefly } from '../clients/firefly';
 import { FFStatus, Organization, Plugin, Plugins, Transaction, Verifier } from '../interfaces';
@@ -33,19 +33,27 @@ export class CommonController {
   @ResponseSchema(Verifier, { isArray: true })
   @OpenAPI({ summary: 'List verifiers (such as Ethereum keys) for all organizations in network' })
   async verifiers(): Promise<Verifier[]> {
-    const orgs = await firefly.getOrganizations();
-    const defaultVerifiers = await firefly.getVerifiers('default');
-    const legacyVerifiers = await firefly.getVerifiers('ff_system');
-    const verifiers = defaultVerifiers.concat(legacyVerifiers);
-
-    const result: Verifier[] = [];
-    for (const v of verifiers) {
-      const o = orgs.find((o) => o.id === v.identity);
-      if (o !== undefined) {
-        result.push({ did: o.did, type: v.type, value: v.value });
+    try {
+      const orgs = await firefly.getOrganizations();
+      let verifiers = await firefly.getVerifiers('default');
+      if (verifiers.length === 0) {
+        // attempt to query legacy ff_system verifiers
+        verifiers = await firefly.getVerifiers('ff_system');
       }
+      const result: Verifier[] = [];
+      for (const v of verifiers) {
+        const o = orgs.find((o) => o.id === v.identity);
+        if (o !== undefined) {
+          result.push({ did: o.did, type: v.type, value: v.value });
+        }
+      }
+      return result;
+    } catch (err) {
+      if (err.message == "FF10187: Namespace does not exist") {
+        return [];
+      }
+      throw new InternalServerError(err.message);
     }
-    return result;
   }
 
   @Get('/verifiers/self')
@@ -92,7 +100,7 @@ export class CommonController {
     const status = await firefly.getStatus();
     if ("multiparty" in status) {
       return {
-        multiparty: status.multiparty.enabled,
+        multiparty: status.multiparty?.enabled,
       };
     } else {
       // Assume multiparty mode if `multiparty` key is missing from status

server/src/controllers/contracts.ts

@@ -152,6 +152,9 @@ export class ContractsController {
     const listener = await firefly.createContractAPIListener(body.apiName, body.eventPath, {
       topic: body.topic,
       name: body.name,
+      options: {
+        firstEvent: body.firstEvent
+      }
     });
     return {
       id: listener.id,
@@ -214,6 +217,9 @@ export class ContractsTemplateController {
         {
           topic: <%= ${q('topic')} %>,<% if (name) { %>
           <% print('name: ' + ${q('name')} + ',') } %>
+          options: {<% if (firstEvent) { %>
+            <% print('firstEvent: ' + ${q('firstEvent')} + ',') } %>
+          }
         },
       );
       return {

server/src/controllers/tokens.ts

@@ -67,6 +67,7 @@ export class TokensController {
       type: body.type,
       config: {
         address: body.address,
+        blockNumber: body.blockNumber,
       },
     });
     return { type: 'token_pool', id: pool.id };
@@ -259,6 +260,7 @@ export class TokensTemplateController {
         type: <%= ${q('type')} %>,
         config: {<% if (address) { %>
           <% print('address: ' + ${q('address')} + ',') } %>
+          blockNumber: <%= ${q('blockNumber')} %>,
         }
       });
       return { type: 'token_pool', id: pool.id };

server/src/interfaces.ts

@@ -40,6 +40,11 @@ export class DatatypeDefinition {
   version: string;
 }
 
+export class FFContractListenerOptions {
+  @IsOptional()
+  firstEvent: string;
+}
+
 export class BroadcastValue extends BaseMessageFields {
   @IsString()
   @IsOptional()
@@ -144,6 +149,10 @@ export class TokenPoolInput {
   @IsString()
   @IsOptional()
   address?: string;
+
+  @IsString()
+  @IsOptional()
+  blockNumber?: string;
 }
 
 export class TokenPool extends TokenPoolInput {
@@ -305,6 +314,10 @@ export class ContractListener {
 
   @IsString()
   eventPath: string;
+
+  @IsOptional()
+  @IsString()
+  firstEvent?: string;
 }
 
 export class ContractListenerLookup {

server/test/common.test.ts

@@ -62,7 +62,6 @@ describe('Common Operations', () => {
 
     mockFireFly.getOrganizations.mockResolvedValueOnce(orgs);
     mockFireFly.getVerifiers.mockResolvedValueOnce(verifiers);
-    mockFireFly.getVerifiers.mockResolvedValueOnce([]);
 
     await request(server)
       .get('/api/common/verifiers')
@@ -71,8 +70,5 @@ describe('Common Operations', () => {
 
     expect(mockFireFly.getOrganizations).toHaveBeenCalledWith();
     expect(mockFireFly.getVerifiers).toHaveBeenCalledWith('default');
-
-    expect(mockFireFly.getOrganizations).toHaveBeenCalledWith();
-    expect(mockFireFly.getVerifiers).toHaveBeenCalledWith('ff_system');
   });
 });

server/test/contracts.template.test.ts

@@ -127,6 +127,7 @@ describe('Templates: Smart Contracts', () => {
             topic: 'app1',
             apiName: 'api1',
             eventPath: 'set',
+            firstEvent: 'newest',
           }),
         ).toBe(
           formatTemplate(`
@@ -135,6 +136,9 @@ describe('Templates: Smart Contracts', () => {
               'set',
               {
                 topic: 'app1',
+                options: {
+                  firstEvent: 'newest',
+                }
               },
             );
             return {

server/test/contracts.test.ts

@@ -226,6 +226,7 @@ describe('Smart Contracts', () => {
       apiName: 'my-api',
       eventPath: 'Changed',
       topic: 'my-app',
+      firstEvent: 'newest'
     };
     const listener = {
       id: 'listener1',
@@ -245,6 +246,9 @@ describe('Smart Contracts', () => {
 
     expect(mockFireFly.createContractAPIListener).toHaveBeenCalledWith('my-api', 'Changed', {
       topic: 'my-app',
+      options: {
+        firstEvent: 'newest',
+      },
     });
   });
 });

server/test/tokens.template.test.ts

@@ -16,6 +16,7 @@ describe('Templates: Tokens', () => {
             symbol: 'P1',
             type: 'fungible',
             address: undefined,
+            blockNumber: '0',
           }),
         ).toBe(
           formatTemplate(`
@@ -24,6 +25,7 @@ describe('Templates: Tokens', () => {
               symbol: 'P1',
               type: 'fungible',
               config: {
+                blockNumber: '0',
               }
             });
             return { type: 'token_pool', id: pool.id };

ui/src/App.tsx

@@ -11,6 +11,10 @@ import {
   SnackbarMessageType,
 } from './components/Snackbar/MessageSnackbar';
 import { SDK_PATHS } from './constants/SDK_PATHS';
+import {
+  GatewayTutorialSections,
+  TutorialSections,
+} from './constants/TutorialSections';
 import { ApplicationContext } from './contexts/ApplicationContext';
 import { SnackbarContext } from './contexts/SnackbarContext';
 import {
@@ -19,13 +23,14 @@ import {
   ISelfIdentity,
   IVerifier,
 } from './interfaces/api';
+import { ITutorialSection } from './interfaces/tutorialSection';
 import { themeOptions } from './theme';
 import { fetchCatcher, summarizeFetchError } from './utils/fetches';
 
 export const MAX_FORM_ROWS = 10;
 
 function App() {
-  const [initialized, setInitialized] = useState(true);
+  const [initialized, setInitialized] = useState(false);
   const [message, setMessage] = useState('');
   const [messageType, setMessageType] = useState<SnackbarMessageType>('error');
 
@@ -41,6 +46,9 @@ function App() {
   });
   const [tokensDisabled, setTokensDisabled] = useState(false);
   const [blockchainPlugin, setBlockchainPlugin] = useState('');
+  const [tutorialSections, setTutorialSections] = useState<ITutorialSection[]>(
+    []
+  );
 
   useEffect(() => {
     Promise.all([
@@ -59,6 +67,7 @@ function App() {
         const ffStatus = statusResponse as IFireflyStatus;
         setMultiparty(ffStatus.multiparty);
         if (ffStatus.multiparty === true) {
+          setTutorialSections(TutorialSections);
           fetchCatcher(SDK_PATHS.verifiers)
             .then((verifierRes: IVerifier[]) => {
               setSelfIdentity({
@@ -71,6 +80,8 @@ function App() {
             .catch((err) => {
               reportFetchError(err);
             });
+        } else {
+          setTutorialSections(GatewayTutorialSections);
         }
       })
       .finally(() => {
@@ -110,6 +121,7 @@ function App() {
             tokensDisabled,
             blockchainPlugin,
             multiparty,
+            tutorialSections,
           }}
         >
           <StyledEngineProvider injectFirst>

ui/src/AppWrapper.tsx

@@ -40,11 +40,17 @@ export const DEFAULT_ACTION = [
   TUTORIAL_FORMS.BROADCAST,
 ];
 
+export const DEFAULT_GATEWAY_ACTION = [
+  TUTORIAL_CATEGORIES.TOKENS,
+  TUTORIAL_FORMS.POOL,
+];
+
 export const AppWrapper: React.FC = () => {
   const { pathname, search } = useLocation();
   const [searchParams, setSearchParams] = useSearchParams();
   const { t } = useTranslation();
-  const { setPayloadMissingFields } = useContext(ApplicationContext);
+  const { setPayloadMissingFields, multiparty, tutorialSections } =
+    useContext(ApplicationContext);
   const [action, setAction] = useState<string | null>(null);
   const [categoryID, setCategoryID] = useState<string | undefined>(undefined);
   const [formID, setFormID] = useState<string | undefined>(undefined);
@@ -64,7 +70,7 @@ export const AppWrapper: React.FC = () => {
 
   useEffect(() => {
     initializeFocusedForm();
-  }, [pathname, search]);
+  }, [pathname, search, tutorialSections]);
 
   // Set form object based on action
   useEffect(() => {
@@ -84,11 +90,16 @@ export const AppWrapper: React.FC = () => {
 
   const initializeFocusedForm = () => {
     const existingAction = searchParams.get(ACTION_QUERY_KEY);
-
     if (existingAction === null) {
-      setCategoryID(DEFAULT_ACTION[0]);
-      setFormID(DEFAULT_ACTION[1]);
-      setActionParam(DEFAULT_ACTION[0], DEFAULT_ACTION[1]);
+      if (multiparty) {
+        setCategoryID(DEFAULT_ACTION[0]);
+        setFormID(DEFAULT_ACTION[1]);
+        setActionParam(DEFAULT_ACTION[0], DEFAULT_ACTION[1]);
+      } else {
+        setCategoryID(DEFAULT_GATEWAY_ACTION[0]);
+        setFormID(DEFAULT_GATEWAY_ACTION[1]);
+        setActionParam(DEFAULT_GATEWAY_ACTION[0], DEFAULT_GATEWAY_ACTION[1]);
+      }
     } else {
       const validAction: string[] = getValidAction(existingAction);
       setCategoryID(validAction[0]);
@@ -134,7 +145,11 @@ export const AppWrapper: React.FC = () => {
 
   const getValidAction = (action: string) => {
     if (!isValidAction(action)) {
-      return DEFAULT_ACTION;
+      if (multiparty) {
+        return DEFAULT_ACTION;
+      } else {
+        return DEFAULT_GATEWAY_ACTION;
+      }
     }
 
     return action.split(ACTION_DELIM);

ui/src/components/Forms/Contracts/RegisterContractApiListenerForm.tsx

@@ -29,6 +29,7 @@ export const RegisterContractApiListenerForm: React.FC = () => {
   const [contractApi, setContractApi] = useState<string>('');
   const [events, setEvents] = useState<string[]>([]);
   const [eventPath, setEventPath] = useState<string>('');
+  const [firstEvent, setFirstEvent] = useState('newest');
 
   const [name, setName] = useState<string>('');
   const [topic, setTopic] = useState<string>('');
@@ -52,8 +53,9 @@ export const RegisterContractApiListenerForm: React.FC = () => {
       topic,
       apiName: contractApi,
       eventPath,
+      firstEvent,
     });
-  }, [name, topic, contractApi, eventPath, formID]);
+  }, [name, topic, contractApi, eventPath, formID, firstEvent]);
 
   useEffect(() => {
     isMounted &&
@@ -157,6 +159,17 @@ export const RegisterContractApiListenerForm: React.FC = () => {
             />
           </FormControl>
         </Grid>
+        <Grid item xs={12}>
+          <FormControl fullWidth required>
+            <TextField
+              fullWidth
+              label={t('firstEvent')}
+              onChange={(e) => setFirstEvent(e.target.value)}
+              helperText={t('firstEventDescription')}
+              value={firstEvent}
+            />
+          </FormControl>
+        </Grid>
       </Grid>
     </Grid>
   );