Press n or j to go to the next uncovered block, b, p or k for the previous block.
| 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 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 446 447 448 449 450 451 452 453 454 455 456 457 458 459 460 461 462 463 464 465 466 467 468 469 470 471 472 473 474 475 476 477 478 479 480 481 482 483 484 485 486 487 488 489 490 491 492 493 494 495 496 497 498 499 500 501 502 503 504 505 506 507 508 509 510 511 512 513 514 515 | 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x | const fs = require('fs');
const path = require('path');
const chalk = require('chalk');
const stringArgv = require('string-argv');
const _ = require('lodash');
const { getSTDInput, parseLogs } = require('@haechi-labs/vvisp-utils');
const { STATE_FILE } = require('../config/Constant');
Eif (!String.prototype.format) {
String.prototype.format = function() {
const args = arguments;
return this.replace(/{(\d+)}/g, function(match, number) {
return typeof args[number] != 'undefined' ? args[number] : match;
});
};
}
const defaultStateFile = STATE_FILE;
/**
*
* console function:
* 1. check script path and get available contract list
* 2. check the state json file
* 2.1 if the state json is not exist, let the user enter the address for each contract.
* 2.2 if the state json is exist, get the address from the json file.
* 3. start interactive console
*
*
* interactive console has following command
* command:
* - register: register the address of smart contracts
* - show <name>: show all the available api in the contract
* - call <name> <method> [params...]: call the method
* - list: show all contracts name and address
* - help: print help message
*/
module.exports = async function(scriptPath, options) {
options = require('./utils/injectConfig')(options);
let rawApis = setApi(scriptPath, options);
if (rawApis === undefined || rawApis === '') {
return;
}
let apis;
if (fs.existsSync(defaultStateFile)) {
apis = setApiAddress(rawApis, defaultStateFile);
} else {
apis = await getAddressFromSTDIN(rawApis);
}
printApiInfo(apis);
const apiCommander = new ApiCommander(apis);
apiCommander.add(
new Command(
'register',
'',
'register the address of smart contracts',
register
)
);
apiCommander.add(
new Command('list', '', 'list the available smart contracts', list)
);
apiCommander.add(
new Command(
'show',
'<Name>',
'show the available method of a smart contract',
show
)
);
apiCommander.add(
new Command(
'call',
'<Name> <Method> [Params...]',
'call a smart contract api method',
call
)
);
await apiCommander.run(options);
process.exit(1);
};
function Command(name, options, description, func) {
return {
name: name,
options: options,
description: description,
run: func
};
}
/**
*
* @param {object} apis has an api of smart contracts
*/
function ApiCommander(apis) {
return {
end: true,
apis: apis,
commands: {},
add: function(command) {
this.commands[command.name] = command;
},
run: async function(options) {
while (this.end) {
const prompt = '>> ';
const line = await getSTDInput(prompt);
const args = stringArgv(line);
if (args.length === 0) {
continue;
}
// check default command
switch (args[0]) {
case 'help':
let msg = 'Usage: <command> [<args...>]\n\n';
msg = msg + 'where <command> is one of: call, show, list, help\n\n';
msg = msg + 'Commands:\n\n';
for (const key of Object.keys(this.commands)) {
const command = this.commands[key];
msg =
msg +
'\t{0} {1}{2}\n\n'.format(
chalk.bold(command.name.padEnd(8)),
chalk.bold(command.options.padEnd(60)),
command.description
);
}
console.log(msg);
continue;
case 'exit':
this.end = false;
continue;
}
if (this.commands[args[0]] === undefined) {
console.log('invalid command: {0}'.format(args[0]));
continue;
}
// run command
try {
await this.commands[args[0]].run(
args.slice(1, args.length),
this.apis,
options
);
} catch (e) {
console.log(e);
}
}
}
};
}
/**
*
* @param {object} apis has an api of smart contracts
*/
function printApiInfo(apis) {
let msg = 'Available contract contracts:\n';
console.log(msg);
console.log(getApiInfo(apis));
console.log('\nIf you are wondering how to use it, type help command.');
console.log(chalk.bold('Use exit or Ctrl-c to exit'));
}
/**
* Print all the api methods of the smart contract
* @param {object} args is a list of command args
* @param {object} apis has an api of smart contracts
*/
async function show(args, apis) {
if (args.length !== 1) {
console.log(
'invalid number of args: should be 1, got {0}'.format(args.length)
);
return;
}
const contractKey = args[0];
if (apis[contractKey] === undefined) {
console.log("'{0}' contract does not exist".format(args[0]));
return;
}
const contract = new apis[contractKey]['api'](
apis[contractKey]['address'].toLowerCase()
);
let msg = '\n' + '[Method]'.padEnd(40) + '[Args]\n';
apis[contractKey].api['abi']
.filter(function(obj) {
return obj.type === 'function';
})
.sort(function(a, b) {
if (a.name < b.name) {
return -1;
}
if (a.name > b.name) {
return 1;
}
return 0;
})
.forEach(function(functionAbi) {
msg =
msg +
'{0}[{1}]\n'.format(
functionAbi.name.padEnd(40),
getArgs(contract['methods'][functionAbi.name], functionAbi).join(', ')
);
});
console.log(msg);
}
function getArgs(func, functionAbi) {
return functionAbi.inputs.map((input, i) => {
return input.type + ' ' + (input.name || `input${i + 1}`);
});
}
async function register() {
console.log(
'To dynamically register a contract to the console, write the contract name, address, and filename.'
);
const contractName = await getSTDInput('Enter the name of contract: ');
const questions = ['address', 'fileName', 'name'];
const contract = {};
for (const key in questions) {
contract[questions[key]] = await getSTDInput(
'Enter the {0} of the contract: '.format(questions[key])
);
}
const f = fs.readFileSync(defaultStateFile, { encoding: 'utf8' });
const state = JSON.parse(f);
const contracts = state['contracts'];
contracts[contractName] = contract;
fs.writeFileSync(defaultStateFile, JSON.stringify(state, null, 2));
console.log(
'The address and filename information of the contract has been successfully saved to state.vvisp.json.'
);
}
/**
*
* Call api of a smart contract and print a result.
* @param {object} args is a list of command args
* @param {object} apis has an api of smart contracts
* @param {object} options is a global option
*/
async function call(args, apis, options) {
if (args.length < 2) {
console.log(
'invalid number of args: should be at least 2(contract name, method name), got {0}'.format(
args.length
)
);
return;
}
const contractKey = args[0];
const methodName = args[1];
if (apis[contractKey] === undefined) {
console.log('no {0} contract is exist'.format(args[0]));
return;
}
const params = args.slice(2, args.length).map(param => {
// convert array string to array
// "[0x123, 0x234]" to ["0x123", "0x234"]
if (param.startsWith('[') && param.endsWith(']')) {
return param
.slice(1, param.length - 1)
.split(/\s*,\s*/)
.map(v => {
// remove empty space for each element
return v.trim();
});
}
return param;
});
params.push({
gasLimit: options.config.gasLimit,
gasPrice: options.config.gasPrice,
platform: options.config.platform
});
const receiptFilter = [
'transactionHash',
'transactionIndex',
'blockNumber',
'from',
'to',
'gasUsed',
'logs',
'name',
'args'
];
const contract = new apis[contractKey]['api'](
apis[contractKey]['address'].toLowerCase()
);
try {
if (!contract.methods[methodName]) {
throw new Error(`There is no function name of ${methodName}`);
}
const receipt = await contract.methods[methodName].apply(undefined, params);
if (typeof receipt !== 'object') {
// result of constant functions
console.log(JSON.stringify(receipt, undefined, 2));
} else if (Array.isArray(receipt.logs)) {
// receipt is Receipt of transaction
const events = parseLogs(receipt.logs, apis[contractKey].api['abi']);
const logs = [];
for (const key in events) {
logs.push({
transactionHash: events[key].transactionHash,
name: events[key].name,
args: events[key].args
});
}
receipt.logs = undefined;
const result = JSON.parse(JSON.stringify(receipt, receiptFilter));
result.logs = logs;
console.log(JSON.stringify(result, undefined, 2));
} else {
// multiple constant return values
const result = JSON.parse(JSON.stringify(receipt, null));
console.log(JSON.stringify(result, undefined, 2));
}
} catch (e) {
console.log(e);
}
}
/**
*
* Print all available smart contracts
* @param {object} args is a list of command args
* @param {object} apis has an api of smart contracts
*/
async function list(args, apis) {
if (args.length !== 0) {
console.log(
'invalid number of args: should be 0, got {0}'.format(args.length)
);
return;
}
console.log(getApiInfo(apis));
}
/**
*
* Get the information of apis
* @param {object} apis has an api of smart contracts
* @RETURN {string} info shows the currently used smart contracts and address.
*/
function getApiInfo(apis) {
const pad1 = 10;
const pad2 = 20;
let info =
'Index'.padEnd(pad1) +
'Name'.padEnd(pad2) +
'Contract'.padEnd(pad2) +
'Address\n';
let i = 0;
for (const [key, contract] of Object.entries(apis)) {
const address = contract.address;
if (address) {
info =
info +
`[${i}]`.padEnd(pad1) +
key.padEnd(pad2) +
contract.name.padEnd(pad2) +
address +
'\n';
i++;
}
}
return info;
}
/**
*
* Get the script api and abi of a smart contract from contractApis
* @param {string} scriptPath is a path to contractApi which is generated
* from vvisp gen-script command
* @param {object} options is the configuration information
* @return {object} object has an api of smart contracts
*/
function setApi(scriptPath, options = {}) {
const defaultScriptPath = process.cwd() + '/contractApis';
if (scriptPath === undefined || scriptPath === '') {
scriptPath = defaultScriptPath;
}
if (!fs.existsSync(scriptPath)) {
console.log(
"Run 'vvisp gen-script' command first to create api of smart contracts."
);
return;
}
// set script api
// omit configuration functions
const apis = _.omit(
require(path.join(scriptPath, 'back') + '/index.js')({
...options.config._values
}),
['config']
);
// set abi
for (const key of Object.keys(apis)) {
apis[key]['abi'] = require(path.join(scriptPath, 'back', 'abi') +
'/' +
key +
'.json');
}
return apis;
}
/**
*
* Set the address of the contract from state.json file
* @param {object} rawApis is a object that has an api of smart contracts
* @param {string} stateFilePath is a path of vvisp.state.json file
* @RETURN {object} apis is a object having an api of smart contracts
*/
function setApiAddress(rawApis, stateFilePath) {
const f = fs.readFileSync(stateFilePath, { encoding: 'utf8' });
const state = JSON.parse(f);
const contracts = state['contracts'];
if (Object.keys(contracts).length === 0) {
throw new Error('There are no contracts in the state file.');
}
for (const key of Object.keys(contracts)) {
let name = contracts[key]['name'];
if (!name) {
const filePath = contracts[key]['fileName'];
if (!filePath) {
throw new Error('fileName does not exist in state.vvisp.json');
}
name = path.parse(filePath).name;
}
if (rawApis[name]) {
contracts[key]['api'] = rawApis[name];
contracts[key]['name'] = name;
} else {
// mismatch occurred between vvisp.state and apis
throw new Error(
'Mismatch has occurred between state.vvisp.json and apis. Please check state.vvisp.json file and contractApis/'
);
}
}
return contracts;
}
/**
* Get the address of the contract from stdin and set address to apis
* @param {object} rawApis is a object having an api of smart contracts
* @returns {object} apis is a object having an api and address of smart contracts
*/
async function getAddressFromSTDIN(rawApis) {
console.log(
"'{0}' does not existing in current path({1})\n".format(
defaultStateFile,
process.cwd()
)
);
console.log(
"Run 'vvisp deploy-service' command to create state.vvisp.json and rerun 'vvisp console' again, \nor enter the address of the currently registered contract\n"
);
console.log('Available contract contracts:');
for (const key of Object.keys(rawApis)) {
console.log('%s', key);
}
const contracts = {};
for (const key of Object.keys(rawApis)) {
const address = await getSTDInput(
'\nEnter the address of {0}: '.format(key)
);
contracts[key] = {
api: rawApis[key],
address: address
};
}
return contracts;
}
|