account.md

Account

The Account class models Antelope accounts and is the primary entity used to interact with the blockchain. A contract can be deployed on an account and used to send transactions and read table data.

Accounts are created using the createAccount method of the Chain object.

Properties

name: string

Account name

chain: Chain

Reference to the Chain instance this account belongs to

contract: Contract

The contract installed on the account if it exists

Constructor

constructor(chain: Chain, name: string): Account

parameters

1. chain - chain: Instance of the Chain class
2. name - string: Name of the new antelope account

Note: The recommended method of creating a new account is to call Chain.createAccount()

Methods

updateAuth(permission: string, parent: string, threshold: number, keys, accounts, waits = [])

Updates the permission for an account.

parameters

1. permission - string: permission name
2. parent - string: parent permission name
3. threshold - number: number of weights required
4. keys - keys: list of public keys and weights
5. accounts: list of accounts and weights
6. waits: list of time weights and waits

Example

Add the permission testauth as a child of the active permission. The testauth permission will have a threshold of 2 and two keys each with a weight of 1. The permission acc11.test@eosio.code will have a weight of 2.

    await account.updateAuth(
      'testauth',
      'active',
      2,
      [
        {
          key: 'EOS7Gk5QTRcKsK5grAuZkLyPTSw5AcQpCz2VDWGi5DPBvfZAG7H9b',
          weight: 1,
        },
        {
          key: 'EOS8cFt6PzBL79kp9vPwWoX8V6cjwgShbfUsyisiZ1M8QaFgZtep6',
          weight: 1,
        },
      ],
      [
        {
          permission: {
            actor: 'acc11.test',
            permission: 'eosio.code',
          },
          weight: 2,
        },
      ]
    );

Result

cleos -u http://localhost:708 get account testaccount1
created: 2022-07-24T19:46:54.000
permissions: 
     owner     1:    1 EOS5dUsCQCAyHVjnqr6BFqVEE7w8XksnkRtz22wd9eFrSq4NHoKEH
        active     1:    1 EOS5dUsCQCAyHVjnqr6BFqVEE7w8XksnkRtz22wd9eFrSq4NHoKEH
           testauth     2:    1 EOS7Gk5QTRcKsK5grAuZkLyPTSw5AcQpCz2VDWGi5DPBvfZAG7H9b, 1 EOS8cFt6PzBL79kp9vPwWoX8V6cjwgShbfUsyisiZ1M8QaFgZtep6, 2 acc11.test@eosio.code

getInfo()

A wrapper around the get_account RPC method.

getBalance()

A wrapper around the get_currency_balance RPC method.

addAuth(permission: string, parent: string)

Adds a permission to an account. The new permission will inherit the active authorization.

Example

Adds a new persmission addauth1111 as a child to the testauth permission.

await account.addAuth('addauth11111', 'testauth');

Result

cleos -u http://localhost:1384 get account testaccount1
created: 2022-07-24T19:55:15.000
permissions: 
   owner     1:    1 EOS5dUsCQCAyHVjnqr6BFqVEE7w8XksnkRtz22wd9eFrSq4NHoKEH
      active     1:    1 EOS5dUsCQCAyHVjnqr6BFqVEE7w8XksnkRtz22wd9eFrSq4NHoKEH
         newcodeauth     1:    1 testaccount1@eosio.code
         testauth     2:    1 EOS7Gk5QTRcKsK5grAuZkLyPTSw5AcQpCz2VDWGi5DPBvfZAG7H9b, 1 EOS8cFt6PzBL79kp9vPwWoX8V6cjwgShbfUsyisiZ1M8QaFgZtep6, 2 acc11.test@eosio.code
            addauth11111     1:    1 EOS5dUsCQCAyHVjnqr6BFqVEE7w8XksnkRtz22wd9eFrSq4NHoKEH

linkAuth(code: string, type: string, permission: string)

A wrapper around the eosio:linkauth contract action.

Example

Allow addauth11111 to authorize the eosio.token:transfer action.

const transaction = await account.linkAuth('eosio.token', 'transfer', 'addauth11111');

Result

The addauth1111 autority is able to authorize the eosio.token:transfer action.

addCode(permission: string)

A helper function to set the eosio.code permission on a given account.

transfer(to: string, quantity: string, memo: string = '')

A wrapper around eosio:token action. Assumes the chain has been started with system contracts installed.

setContract(contractPath: ContractPath): Contract

A wrapper around the eosio:setcode and eosio:setabi actions.

Example

await contractAccount.setContract({
    abi: './contracts/build/testcontract.abi',
    wasm: './contracts/build/testcontract.wasm'
  });