193 |
194 |
195 |
196 |
197 |
198 |
--------------------------------------------------------------------------------
/src/steem/misc.ts:
--------------------------------------------------------------------------------
1 | /**
2 | * @file Misc steem type definitions.
3 | * @author Johan Nordberg
4 | * @license
5 | * Copyright (c) 2017 Johan Nordberg. All Rights Reserved.
6 | *
7 | * Redistribution and use in source and binary forms, with or without modification,
8 | * are permitted provided that the following conditions are met:
9 | *
10 | * 1. Redistribution of source code must retain the above copyright notice, this
11 | * list of conditions and the following disclaimer.
12 | *
13 | * 2. Redistribution in binary form must reproduce the above copyright notice,
14 | * this list of conditions and the following disclaimer in the documentation
15 | * and/or other materials provided with the distribution.
16 | *
17 | * 3. Neither the name of the copyright holder nor the names of its contributors
18 | * may be used to endorse or promote products derived from this software without
19 | * specific prior written permission.
20 | *
21 | * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND
22 | * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
23 | * WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED.
24 | * IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT,
25 | * INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING,
26 | * BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
27 | * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF
28 | * LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE
29 | * OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED
30 | * OF THE POSSIBILITY OF SUCH DAMAGE.
31 | *
32 | * You acknowledge that this software is not designed, licensed or intended for use
33 | * in the design, construction, operation or maintenance of any military facility.
34 | */
35 | import { Account } from './account'
36 | import {Asset, Price} from './asset'
37 |
38 | /**
39 | * Large number that may be unsafe to represent natively in JavaScript.
40 | */
41 | export type Bignum = string
42 |
43 | /**
44 | * Buffer wrapper that serializes to a hex-encoded string.
45 | */
46 | export class HexBuffer {
47 |
48 | /**
49 | * Convenience to create a new HexBuffer, does not copy data if value passed is already a buffer.
50 | */
51 | public static from(value: Buffer | HexBuffer | number[] | string) {
52 | if (value instanceof HexBuffer) {
53 | return value
54 | } else if (value instanceof Buffer) {
55 | return new HexBuffer(value)
56 | } else if (typeof value === 'string') {
57 | return new HexBuffer(Buffer.from(value, 'hex'))
58 | } else {
59 | return new HexBuffer(Buffer.from(value))
60 | }
61 | }
62 |
63 | constructor(public buffer: Buffer) {}
64 |
65 | public toString(encoding = 'hex') {
66 | return this.buffer.toString(encoding)
67 | }
68 |
69 | public toJSON() {
70 | return this.toString()
71 | }
72 |
73 | }
74 |
75 | /**
76 | * Chain roperties that are decided by the witnesses.
77 | */
78 | export interface ChainProperties {
79 | /**
80 | * This fee, paid in STEEM, is converted into VESTING SHARES for the new account. Accounts
81 | * without vesting shares cannot earn usage rations and therefore are powerless. This minimum
82 | * fee requires all accounts to have some kind of commitment to the network that includes the
83 | * ability to vote and make transactions.
84 | *
85 | * @note This has to be multiplied by `STEEMIT_CREATE_ACCOUNT_WITH_STEEM_MODIFIER`
86 | * (defined as 30 on the main chain) to get the minimum fee needed to create an account.
87 | *
88 | */
89 | account_creation_fee: string | Asset
90 | /**
91 | * This witnesses vote for the maximum_block_size which is used by the network
92 | * to tune rate limiting and capacity.
93 | */
94 | maximum_block_size: number // uint32_t
95 | /**
96 | * The SBD interest percentage rate decided by witnesses, expressed 0 to 10000.
97 | */
98 | sbd_interest_rate: number // uint16_t STEEMIT_100_PERCENT
99 | }
100 |
101 | export interface VestingDelegation {
102 | /**
103 | * Delegation id.
104 | */
105 | id: number // id_type
106 | /**
107 | * Account that is delegating vests to delegatee.
108 | */
109 | delegator: string // account_name_type
110 | /**
111 | * Account that is receiving vests from delegator.
112 | */
113 | delegatee: string // account_name_type
114 | /**
115 | * Amount of VESTS delegated.
116 | */
117 | vesting_shares: Asset | string
118 | /**
119 | * Earliest date delegation can be removed.
120 | */
121 | min_delegation_time: string // time_point_sec
122 | }
123 |
124 | /**
125 | * Node state.
126 | */
127 | export interface DynamicGlobalProperties {
128 | id: number
129 | /**
130 | * Current block height.
131 | */
132 | head_block_number: number
133 | head_block_id: string
134 | /**
135 | * UTC Server time, e.g. 2020-01-15T00:42:00
136 | */
137 | time: string
138 | /**
139 | * Currently elected witness.
140 | */
141 | current_witness: string
142 | /**
143 | * The total POW accumulated, aka the sum of num_pow_witness at the time
144 | * new POW is added.
145 | */
146 | total_pow: number
147 | /**
148 | * The current count of how many pending POW witnesses there are, determines
149 | * the difficulty of doing pow.
150 | */
151 | num_pow_witnesses: number
152 | virtual_supply: Asset | string
153 | current_supply: Asset | string
154 | /**
155 | * Total asset held in confidential balances.
156 | */
157 | confidential_supply: Asset | string
158 | current_sbd_supply: Asset | string
159 | /**
160 | * Total asset held in confidential balances.
161 | */
162 | confidential_sbd_supply: Asset | string
163 | total_vesting_fund_steem: Asset | string
164 | total_vesting_shares: Asset | string
165 | total_reward_fund_steem: Asset | string
166 | /**
167 | * The running total of REWARD^2.
168 | */
169 | total_reward_shares2: string
170 | pending_rewarded_vesting_shares: Asset | string
171 | pending_rewarded_vesting_steem: Asset | string
172 | /**
173 | * This property defines the interest rate that SBD deposits receive.
174 | */
175 | sbd_interest_rate: number
176 | sbd_print_rate: number
177 | /**
178 | * Average block size is updated every block to be:
179 | *
180 | * average_block_size = (99 * average_block_size + new_block_size) / 100
181 | *
182 | * This property is used to update the current_reserve_ratio to maintain
183 | * approximately 50% or less utilization of network capacity.
184 | */
185 | average_block_size: number
186 | /**
187 | * Maximum block size is decided by the set of active witnesses which change every round.
188 | * Each witness posts what they think the maximum size should be as part of their witness
189 | * properties, the median size is chosen to be the maximum block size for the round.
190 | *
191 | * @note the minimum value for maximum_block_size is defined by the protocol to prevent the
192 | * network from getting stuck by witnesses attempting to set this too low.
193 | */
194 | maximum_block_size: number
195 | /**
196 | * The current absolute slot number. Equal to the total
197 | * number of slots since genesis. Also equal to the total
198 | * number of missed slots plus head_block_number.
199 | */
200 | current_aslot: number
201 | /**
202 | * Used to compute witness participation.
203 | */
204 | recent_slots_filled: Bignum
205 | participation_count: number
206 | last_irreversible_block_num: number
207 | /**
208 | * The maximum bandwidth the blockchain can support is:
209 | *
210 | * max_bandwidth = maximum_block_size * STEEMIT_BANDWIDTH_AVERAGE_WINDOW_SECONDS / STEEMIT_BLOCK_INTERVAL
211 | *
212 | * The maximum virtual bandwidth is:
213 | *
214 | * max_bandwidth * current_reserve_ratio
215 | */
216 | max_virtual_bandwidth: Bignum
217 | /**
218 | * Any time average_block_size <= 50% maximum_block_size this value grows by 1 until it
219 | * reaches STEEMIT_MAX_RESERVE_RATIO. Any time average_block_size is greater than
220 | * 50% it falls by 1%. Upward adjustments happen once per round, downward adjustments
221 | * happen every block.
222 | */
223 | current_reserve_ratio: number
224 | /**
225 | * The number of votes regenerated per day. Any user voting slower than this rate will be
226 | * "wasting" voting power through spillover; any user voting faster than this rate will have
227 | * their votes reduced.
228 | */
229 | vote_power_reserve_rate: number
230 | }
231 |
232 | /**
233 | * Return the vesting share price.
234 | */
235 | export function getVestingSharePrice(props: DynamicGlobalProperties): Price {
236 | const totalVestingFund = Asset.from(props.total_vesting_fund_steem)
237 | const totalVestingShares = Asset.from(props.total_vesting_shares)
238 | if (totalVestingFund.amount === 0 || totalVestingShares.amount === 0) {
239 | return new Price(new Asset(1, 'VESTS'), new Asset(1, 'STEEM'))
240 | }
241 | return new Price(totalVestingShares, totalVestingFund)
242 | }
243 |
244 | /**
245 | * Returns the vests of specified account. Default: Subtract delegated & add received
246 | */
247 | export function getVests(account: Account, subtract_delegated: boolean = true, add_received: boolean = true) {
248 | let vests: Asset = Asset.from(account.vesting_shares)
249 | const vests_delegated: Asset = Asset.from(account.delegated_vesting_shares)
250 | const vests_received: Asset = Asset.from(account.received_vesting_shares)
251 | const withdraw_rate: Asset = Asset.from(account.vesting_withdraw_rate)
252 | const already_withdrawn = (Number(account.to_withdraw) - Number(account.withdrawn)) / 1000000
253 | const withdraw_vests = Math.min(withdraw_rate.amount, already_withdrawn)
254 | vests = vests.subtract(withdraw_vests)
255 |
256 | if (subtract_delegated) {
257 | vests = vests.subtract(vests_delegated)
258 | }
259 | if (add_received) {
260 | vests = vests.add(vests_received)
261 | }
262 |
263 | return vests.amount
264 | }
265 |
--------------------------------------------------------------------------------
/docs/interfaces/beneficiaryroute.html:
--------------------------------------------------------------------------------
1 |
2 |
3 |
4 |
5 |
6 | BeneficiaryRoute | dsteem
7 |
8 |
9 |
10 |
11 |
12 |
13 |
Only get irreversible blocks.
97 |