erc20-demurrage-token

ERC20 token with redistributed continual demurrage
Info | Log | Files | Refs | README

erc20-demurrage-token-publish.1 (8025B)


      1 .TH erc20-demurrage-token-publish 1
      2 
      3 .SH NAME
      4 erc20-demurrage-token-publish \- Publishing tool for the ERC20 Demurrage Token smart contract.
      5 
      6 
      7 .SH SYNOPSIS
      8 .SY erc20-demurrage-token-publish
      9 .RI --name NAME --symbol SYMBOL --decimals DECIMALS --demurrage-level PPM --redistribution-period MINUTES --sink-address ADDRESS
     10 .YS
     11 
     12 
     13 .SH DESCRIPTION
     14 .P
     15 This tool generates the appropriate bytecode to store the ERC20 Demurrage Token smartcontract code on an EVM chain, along with the required construction parameters.
     16 
     17 Arguments for EVM encoding and interaction with EVM RPC node is handled by the \fBchainlib-eth\fP python package.
     18 
     19 Specific arguments for this tool are the \fB--demurrage-level\fP, \fB--redistribution-period\fP and \fB--sink-address\fP arguments.
     20 
     21 
     22 .SS OPTIONS
     23 
     24 .TP
     25 \fB-0\fP
     26 Omit newline to output
     27 
     28 .TP
     29 \fB-c \fI\fIconfig_dir\fP\fP, \fB--config \fI\fIconfig_dir\fP\fP
     30 Load configuration files from given directory. All files with an .ini extension will be loaded, of which all must contain valid ini file data.
     31 
     32 .TP
     33 \fB--demurrage-level \fI\fIlevel
     34 \fP\fP
     35 Level of decay per minute. See SPECIFYING DEMURRAGE below.
     36 
     37 .TP
     38 \fB--dumpconfig \fI\fIformat\fP\fP
     39 Output configuration settings rendered from environment and inputs. Valid arguments are \fIini\fP for ini file output, and \fIenv\fP for environment variable output. See \fBCONFIGURATION\fP.
     40 
     41 .TP
     42 \fB-e\fP, \fB--executable-address\fP
     43 Address of an executable code point on the network.
     44 
     45 .TP
     46 \fB--env-prefix\fP
     47 Environment prefix for variables to overwrite configuration. Example: If \fB--env-prefix\fP is set to \fBFOO\fP then configuration variable \fBBAR_BAZ\fP would be set by environment variable \fBFOO_BAZ_BAR\fP. Also see \fBENVIRONMENT\fP.
     48 
     49 .TP
     50 \fB--fee-limit\fP
     51 Set the limit of execution units for the transaction. If used with \fB-s\fP this may incur actual network token cost. If \fB--fee-price\fP is not explicitly set, the price \fImay\fP be retrieved from the network, and multiplied with this value to define the cost.
     52 
     53 .TP
     54 \fB--fee-price\fP
     55 Set fee unit price to offer for the transaction. If used with \fB-s\fP this may incur actual network token cost.
     56 
     57 .TP
     58 \fB--height\fP
     59 Block height at which to query state for. Does not apply to transactions.
     60 
     61 .TP
     62 \fB-i \fI\fIchain_spec\fP\fP, \fB--chain-spec \fI\fIchain_spec\fP\fP
     63 Chain specification string, in the format <engine>:<fork>:<chain_id>:<common_name>. Example: "evm:london:1:ethereum". Overrides the \fIRPC_CREDENTIALS\fP configuration setting.
     64 
     65 .TP
     66 \fB-n \fI\fInamespace\fP\fP, \fB--namespace \fI\fInamespace\fP\fP
     67 Load given configuration namespace. Configuration will be loaded from the immediate configuration subdirectory with the same name.
     68 
     69 .TP
     70 \fB--no-logs\fP
     71 Turn of logging completely. Negates \fB-v\fP and \fB-vv\fP
     72 
     73 .TP
     74 \fB--nonce\fP
     75 Explicitly set nonce to use for transaction.
     76 
     77 .TP
     78 \fB-p\fP, \fB--rpc-provider\fP
     79 Fully-qualified URL of RPC provider. Overrides the \fIRPC_PROVIDER\fP configuration setting.
     80 
     81 .TP
     82 \fB--passphrase-file \fI\fIpath\fP\fP
     83 Path to file containing password to unlock key file
     84 
     85 .TP
     86 \fB--raw\fP
     87 Produce output most optimized for machines.
     88 
     89 .TP
     90 \fB--redistribution-period \fI\fIminutes
     91 \fP\fP
     92 Number of minuntes between each withdrawal of demurraged value is possible.
     93 
     94 .TP
     95 \fB--rpc-auth\fP
     96 RPC endpoint authentication method, e.g. how to handle a HTTP WWW-Authenticate header. Overrides the \fIRPC_AUTH\fP configuration setting.
     97 
     98 .TP
     99 \fB--rpc-credentials\fP
    100 RPC endpoint authentication data. Format depends on the authentication method defined in \fB--rpc-auth\fP. Overrides the \fIRPC_CREDENTIALS\fP configuration setting.
    101 
    102 .TP
    103 \fB--rpc-dialect\fP
    104 RPC backend dialect. If specified it \fImay\fP help with encoding and decoding issues. Overrides the \fIRPC_DIALECT\fP configuration setting.
    105 
    106 .TP
    107 \fB-s\fP
    108 Send to network. If set, network state may change. This means tokens may be spent and so on. Use with care. Only applies to transactions.
    109 
    110 .TP
    111 \fB--seq\fP
    112 Use numeric sequencial jsonrpc query ids. Useful for buggy server implementations who expects such.
    113 
    114 .TP
    115 \fB--sink-address \fI\fIaddress
    116 \fP\fP
    117 Initial address receiving the demurrage value withdrawal.
    118 
    119 .TP
    120 \fB-u\fP, \fB--unsafe\fP
    121 Allow addresses that do not pass checksum.
    122 
    123 .TP
    124 \fB-v\fP
    125 Verbose. Show logs for important state changes.
    126 
    127 .TP
    128 \fB-vv\fP
    129 Very verbose. Show logs with debugging information.
    130 
    131 .TP
    132 \fB-w\fP
    133 Wait for the last transaction to be confirmed on the network. Will generate an error if the EVM execution fails.
    134 
    135 .TP
    136 \fB-ww\fP
    137 Wait for \fIall\fP transactions sequentially to be confirmed on the network. Will generate an error if EVM execution fails for any of the transactions.
    138 
    139 .TP
    140 \fB-y \fI\fIpath\fP\fP, \fB--key-path \fI\fIpath\fP\fP
    141 Path to signing key. Overrides the \fIWALLET_KEY_FILE\fP configuration setting.
    142 
    143 .SH CONFIGURATION
    144 
    145 All configuration settings may be overriden both by environment variables, or by overriding settings with the contents of ini-files in the directory defined by the \fB-c\fP option.
    146 
    147 The active configuration, with values assigned from environment and arguments, can be output using the \fB--dumpconfig\fP \fIformat\fP option. Note that entries having keys prefixed with underscore (e.g. _SEQ) are not actual configuration settings, and thus cannot be overridden with environment variables.
    148 
    149 To refer to a configuration setting by environment variables, the \fIsection\fP and \fIkey\fP are concatenated together with an underscore, and transformed to upper-case. For example, the configuration variable \fIFOO_BAZ_BAR\fP refers to an ini-file entry as follows:
    150 
    151 .EX
    152 [foo]
    153 bar_baz = xyzzy
    154 .EE
    155 
    156 In the \fBENVIRONMENT\fP section below, the relevant configuration settings for this tool is listed along with a short description of its meaning.
    157 
    158 Some configuration settings may also be overriden by command line options. Also note that the use of the \fB-n\fP and \fB--env-prefix\fP options affect how environment and configuration is read. The effects of options on how configuration settings are affective is described in the respective \fBOPTIONS\fP section.
    159 
    160 .SH SPECIFYING DEMURRAGE
    161 
    162 Demurrage is specified as a parts-per-million value in terms of the chosen \fI--redistribution-period\fP.
    163 
    164 For example, a value of \fB20000\fP with a \fI--redistribution-period\fP of \fB43200\fP corresponds to a \fB2%\fP demurrage per \fB30\fP days.
    165 .SH ENVIRONMENT
    166 
    167 
    168 .TP
    169 \fICHAIN_SPEC\fP
    170 String specifying the type of chain connected to, in the format \fI<engine>:<fork>:<network_id>:<common_name>\fP. For EVM nodes the \fIengine\fP value will always be \fIevm\fP.
    171 
    172 .TP
    173 \fIRPC_AUTH\fP
    174 Authentication method to use for the \fIRPC_PROVIDER\fP. Currently only \fIbasic\fP is supported.
    175 
    176 .TP
    177 \fIRPC_CREDENTIALS\fP
    178 Authentication credentials to use for \fIRPC_AUTH\fP. For \fIbasic\fP authentication the value must be given as \fI<user>:<pass>\fP.
    179 
    180 .TP
    181 \fIRPC_DIALECT\fP
    182 Enables translations of EVM node specific formatting and response codes.
    183 
    184 .TP
    185 \fIRPC_PROVIDER\fP
    186 Fully-qualified URL to the RPC endpoint of the blockchain node.
    187 
    188 .TP
    189 \fIWALLET_KEY_FILE\fP
    190 The wallet key file containing private key to use for transaction signing. Overridden by \fB-y\fP.
    191 
    192 .TP
    193 \fIWALLET_PASSPHRASE\fP
    194 Passphrase to unlock wallet. \fBWARNING:\fP it is \fBunsafe\fP to pass the passphrase as an environment variable. If the key unlocks something of value, the passphrase should rather be in a configuration file, preferably as an encrypted entry. Alternatively, a passphrase can be read from file using the \fB--passphrase-file\fP option. Files containing passphrases should only be accessible by the owner.
    195 
    196 .SH LICENSE
    197 
    198 This documentation and its source is licensed under the Creative Commons Attribution-Sharealike 4.0 International license.
    199 
    200 The source code of the tool this documentation describes is licensed under the GNU General Public License 3.0.
    201 
    202 .SH COPYRIGHT
    203 
    204 Louis Holbrook <dev@holbrook.no> (https://holbrook.no)
    205 PGP: 59A844A484AC11253D3A3E9DCDCBD24DD1D0E001
    206 
    207 
    208 
    209 .SH SOURCE CODE
    210 
    211 https://git.defalsify.org
    212 
    213 
    214 .SH SEE ALSO
    215 
    216 .BP
    217 confini-dump(1), eth-keyfile(1)
    218