1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
|
import { SignedOrder, ZeroEx } from '0x.js';
import { Schema, schemas as schemasByName } from '@0xproject/json-schemas';
import * as _ from 'lodash';
import { addresses as kovanAddresses} from './contract_addresses/kovan_addresses';
import { addresses as mainnetAddresses} from './contract_addresses/mainnet_addresses';
interface EnvironmentValue {
key: string;
}
export const postmanEnvironmentFactory = {
/**
* Dynamically generates a postman environment (https://www.getpostman.com/docs/v6/postman/environments_and_globals/manage_environments)
* When running the postman collection via newman, we provide it a set of environment variables
* These variables include:
* - 0x JSON schemas for response body validation
* - Contract addresses based on the network id for making specific queries (ex. baseTokenAddress=ZRX_address)
* - Order properties for making specific queries (ex. maker=orderMaker)
*/
createPostmanEnvironment(url: string, networkId: number, order: SignedOrder) {
const schemas: Schema[] = _.values(schemasByName);
const schemaEnvironmentValues = _.compact(
_.map(schemas, (schema: Schema) => {
if (_.isUndefined(schema.id)) {
return undefined;
} else {
const schemaKey = convertSchemaIdToKey(schema.id);
const stringifiedSchema = JSON.stringify(schema);
const schemaEnvironmentValue = createEnvironmentValue(schemaKey, stringifiedSchema);
return schemaEnvironmentValue;
}
}),
);
const schemaKeys = _.map(schemaEnvironmentValues, (environmentValue: EnvironmentValue) => {
return environmentValue.key;
});
const contractAddresses = getContractAddresses(networkId);
const contractAddressEnvironmentValues = _.map(_.keys(contractAddresses), (key: string) => {
const contractAddress = _.get(contractAddresses, key);
return createEnvironmentValue(key, contractAddress);
});
const allEnvironmentValues = _.concat(
schemaEnvironmentValues,
contractAddressEnvironmentValues,
createEnvironmentValue('schemaKeys', JSON.stringify(schemaKeys)),
createEnvironmentValue('url', url),
createEnvironmentValue('order', JSON.stringify(order)),
createEnvironmentValue('orderMaker', order.maker),
createEnvironmentValue('orderTaker', order.taker),
createEnvironmentValue('orderFeeRecipient', order.feeRecipient),
createEnvironmentValue('orderHash', ZeroEx.getOrderHashHex(order)),
);
const environment = {
values: allEnvironmentValues,
};
return environment;
},
};
function getContractAddresses(networkId: number) {
switch (networkId) {
case 1:
return mainnetAddresses;
case 42:
return kovanAddresses;
default:
throw new Error('Unsupported network id');
}
}
function convertSchemaIdToKey(schemaId: string) {
let result = schemaId;
if (_.startsWith(result, '/')) {
result = result.substr(1);
}
result = `${result}Schema`;
return result;
}
function createEnvironmentValue(key: string, value: string) {
return {
key,
value,
enabled: true,
type: 'text',
};
}
|
