Miss any of our Open RFC calls?Watch the recordings here! »

truffle-personalities

1.0.0 • Public • Published

Truffle Personalities

Alias the default Truffle or Ganache accounts with relatable names.

Behavior

Truffle Personalities will alias n accounts, where n is the lesser of the number of accounts provided and the number of names available. The default list of names, in order of assignment, is as follows:

  1. ALICE
  2. BOB
  3. CAROL
  4. DAVID
  5. EVE
  6. FRANK
  7. GRACE
  8. HEIDI
  9. IVAN
  10. JUDY
  11. KATHERINE
  12. LIAM
  13. MICHAEL
  14. NIAJ
  15. OLIVIA
  16. PEGGY
  17. QUENTIN
  18. RICHARD
  19. SYBIL
  20. TRENT
  21. ULYSSES
  22. VICTOR
  23. WENDY
  24. XIMENA
  25. YAAKOV
  26. ZARA

Installation

npm install --save truffle-personalities

Usage

Pass the accounts array provided to Truffle's contract function to Truffle Personalities.

const trufflePersonalities = require('truffle-personalities');
 
contract('TestContract', function (accounts) {
  trufflePersonalities(accounts);
 
  accounts.ALICE === accounts[0];
  // => true
 
  accounts.BOB === accounts[1];
  // => true
});

Options

An options object may be passed as the second argument.

Option Description Default
context the object to which aliases are assigned accounts
names array of names to assign before using the default names []
toLowerCase boolean describing whether to convert names to lower case rather than to upper case false

Examples

Pass a list of custom names to override the defaults. This example proposes the use of NOLAN as "nobody", or an uninvolved third party, and OWEN as a contract's owner.

trufflePersonalities(accounts, { names: ['NOLAN', 'owen'], toLowerCase: true});
 
accounts.NOLAN === undefined;
// => true
 
accounts.nolan === accounts[0];
// => true
 
accounts.owen === accounts[1];
// => true
 
accounts.alice === accounts[2];
// => true

Pass the global object as the context option in order to access the aliased addresses as standalone variables.

trufflePersonalities(accounts, { context: global });
 
accounts.ALICE === undefined;
// => true
 
ALICE === accounts[0];
// => true

Install

npm i truffle-personalities

DownloadsWeekly Downloads

2

Version

1.0.0

License

MIT

Unpacked Size

3.76 kB

Total Files

3

Last publish

Collaborators

  • avatar