Skip to content

Commit

Permalink
docs update
Browse files Browse the repository at this point in the history
  • Loading branch information
SteakOverCooked authored and SteakOverCooked committed May 21, 2018
1 parent 6586ee4 commit 8b71805
Show file tree
Hide file tree
Showing 2 changed files with 190 additions and 78 deletions.
267 changes: 190 additions & 77 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,78 +1,191 @@
# steemvbs
SteemVBS is the first Steem Library written in VBScript. Yes, it is VBScript. ;)

# Examples
Class `Steem` is declared in `lib\steem.vbs` and you can do something like this

```
Dim SteemIt
Set SteemIt = (New Steem)("https://rpc.steemviz.com")
WScript.Echo SteemIt.Node
SteemIt.Node = "https://api.steemit.com"
WScript.Echo SteemIt.Node
Dim Account
Set Account = SteemIt.GetAccount("justyy")
WScript.Echo Account("voting_power")
```

To run the example:

```
cscript.exe /Nologo steem.wsf examples\account.vbs
```

## Formater Reputation
```
Dim Format
Set Format = New Formatter
Const EPSILON = 1e-3
AssertEqualFloat Format.Reputation(95832978796820), 69.833, EPSILON, "Format.Reputation 95832978796820"
```

## ValidateAccountName
```
Dim u
Set u = New Utility
AssertEqual u.ValidateAccountName("justyy"), "", ""
```

## Get Profile String
```
Dim SteemIt
Set SteemIt = New Steem
WScript.Echo SteemIt.GetAccount_Profile("justyy")
```

## Get Witness Votes
```
Dim SteemIt
Set SteemIt = New Steem
Dim Util
Set Util = New Utility
Dim witness
witness = SteemIt.GetAccount_WitnessVotes("justyy")
AssertTrue Util.InArray("abit", witness), "justyy should vote abit"
```

# Unit Tests
Unit tests can be run via

```
cscript.exe /Nologo tests.wsf tests\test_account.vbs
```

or you can call `run_tests.cmd` to run all tests in the test folder `tests`.

# Roadmap
The features of Steem-Js and Steem-Python will be brought in.

# Notice
# steemvbs
SteemVBS is the first Steem Library written in VBScript. Yes, it is VBScript. ;)

# Examples
Class `Steem` is declared in `lib\steem.vbs` and you can do something like this

```
Dim SteemIt
Set SteemIt = (New Steem)("https://rpc.steemviz.com")
WScript.Echo SteemIt.Node
SteemIt.Node = "https://api.steemit.com"
WScript.Echo SteemIt.Node
Dim Account
Set Account = SteemIt.GetAccount("justyy")
WScript.Echo Account("voting_power")
```

To run the example:

```
cscript.exe /Nologo steem.wsf examples\account.vbs
```

## Formater Reputation
```
Dim Format
Set Format = New Formatter
Const EPSILON = 1e-3
AssertEqualFloat Format.Reputation(95832978796820), 69.833, EPSILON, "Format.Reputation 95832978796820"
```

## ValidateAccountName
```
Dim u
Set u = New Utility
AssertEqual u.ValidateAccountName("justyy"), "", ""
```

## Get Profile String
```
Dim SteemIt
Set SteemIt = New Steem
WScript.Echo SteemIt.GetAccount_Profile("justyy")
```

## Get Witness Votes
```
Dim SteemIt
Set SteemIt = New Steem
Dim Util
Set Util = New Utility
Dim witness
witness = SteemIt.GetAccount_WitnessVotes("justyy")
AssertTrue Util.InArray("abit", witness), "justyy should vote abit"
```

## Adding Real time Voting Power
```
' test GetAccount_VotingPower
Dim SteemIt
Set SteemIt = New Steem
Dim vp
vp = SteemIt.GetAccount_VotingPower("justyy")
AssertTrue vp >= 60 And vp <= 100, "justyy vp should be between 60 and 100"
Set SteemIt = Nothing
```

## Adding Account Effective Steem Power
```
' test GetAccount_EffectiveSteemPower
Dim SteemIt
Set SteemIt = New Steem
Dim esp
esp = SteemIt.GetAccount_EffectiveSteemPower("justyy")
WScript.Echo esp
AssertTrue esp >= 20000, "justyy esp should be larger than 20000"
Set SteemIt = Nothing
```

## Adding CreateSuggestedPassword
```
Dim x
Set x = New Utility
WScript.Echo x.CreateSuggestedPassword
Set x = Nothing
```

## GetUrlFromCommentPermLink
This function returns the steem post url given a comment url

```
' Test GetUrlFromCommentPermLink
Dim x
Set x = New Utility
AssertEqual x.GetUrlFromCommentPermLink("re-tvb-re-justyy-re-tvb-45qr3w-20171011t144205534z"), "https://steemit.com/@tvb/45qr3w", ""
AssertEqual x.GetUrlFromCommentPermLink("re-justyy-daily-quality-cn-posts-selected-and-rewarded-promo-cn-20180520t153728557z"), "https://steemit.com/@justyy/daily-quality-cn-posts-selected-and-rewarded-promo-cn", ""
Set x = Nothing
```

## Vests to Steem Power
```
Dim SteemIt
Set SteemIt = New Steem
WScript.Echo SteemIt.VestsToSp(1234234)
Set SteemIt = Nothing
```

## Invalidate Cache
```
Dim SteemIt
Set SteemIt = New Steem
' fresh
WScript.Echo SteemIt.GetAccount_VotingPower("justyy")
' cached
WScript.Echo SteemIt.GetAccount_VotingPower("justyy")
' do not use cache
SteemIt.Cache = False
WScript.Echo SteemIt.GetAccount_VotingPower("justyy")
Set SteemIt = Nothing
```

## Vests
```
Dim SteemIt
Set SteemIt = New Steem
WScript.Echo SteemIt.GetAccount_VestingShares("justyy")
Set SteemIt = Nothing
```

## Delegated Vests
```
Dim SteemIt
Set SteemIt = New Steem
WScript.Echo SteemIt.GetAccount_DelegatedVestingShares("justyy")
Set SteemIt = Nothing
```

## Received Vests
```
Dim SteemIt
Set SteemIt = New Steem
WScript.Echo SteemIt.GetAccount_ReceivedVestingShares("justyy")
Set SteemIt = Nothing
```

# Unit Tests
Unit tests can be run via

```
cscript.exe /Nologo tests.wsf tests\test_account.vbs
```

or you can call `run_tests.cmd` to run all tests in the test folder `tests`.

# Roadmap
The features of Steem-Js and Steem-Python will be brought in.

# Notice
This library is under development. Beware.
1 change: 0 additions & 1 deletion tests/test_esp.vbs
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,6 @@ Set SteemIt = New Steem
Dim esp
esp = SteemIt.GetAccount_EffectiveSteemPower("justyy")

WScript.Echo esp
AssertTrue esp >= 20000, "justyy esp should be larger than 20000"

Set SteemIt = Nothing

0 comments on commit 8b71805

Please sign in to comment.