From 0c2ecad2bf83725e94a3de02f3b7cb33526c1c9c Mon Sep 17 00:00:00 2001
From: Mahdi Yari <m.yary16@gmail.com>
Date: Tue, 3 Nov 2020 19:28:21 +0330
Subject: [PATCH] add getEscrow

---
 doc/README.md | 44 +++++++++++++++++++++++++++++++-------------
 1 file changed, 31 insertions(+), 13 deletions(-)

diff --git a/doc/README.md b/doc/README.md
index 6ca32f3..688a589 100644
--- a/doc/README.md
+++ b/doc/README.md
@@ -1719,83 +1719,101 @@ hive.broadcast.changeRecoveryAccount(wif, accountToRecover, newRecoveryAccount,
 });
 ```
 ### Comment
-```
+```js
 hive.broadcast.comment(wif, parentAuthor, parentPermlink, author, permlink, title, body, jsonMetadata, function(err, result) {
   console.log(err, result);
 });
 ```
 ### Comment Options
-```
+```js
 hive.broadcast.commentOptions(wif, author, permlink, maxAcceptedPayout, percentHiveDollars, allowVotes, allowCurationRewards, extensions, function(err, result) {
   console.log(err, result);
 });
 ```
 ### Comment Payout
-```
+```js
 hive.broadcast.commentPayout(wif, author, permlink, payout, function(err, result) {
   console.log(err, result);
 });
 ```
 ### Comment Reward
-```
+```js
 hive.broadcast.commentReward(wif, author, permlink, hbdPayout, vestingPayout, function(err, result) {
   console.log(err, result);
 });
 ```
 ### Convert
-```
+```js
 hive.broadcast.convert(wif, owner, requestid, amount, function(err, result) {
   console.log(err, result);
 });
 ```
 ### Curate Reward
-```
+```js
 hive.broadcast.curateReward(wif, curator, reward, commentAuthor, commentPermlink, function(err, result) {
   console.log(err, result);
 });
 ```
 ### Custom
-```
+```js
 hive.broadcast.custom(wif, requiredAuths, id, data, function(err, result) {
   console.log(err, result);
 });
 ```
 ### Custom Binary
-```
+```js
 hive.broadcast.customBinary(wif, id, data, function(err, result) {
   console.log(err, result);
 });
 ```
 ### Custom Json
-```
+```js
 hive.broadcast.customJson(wif, requiredAuths, requiredPostingAuths, id, json, function(err, result) {
   console.log(err, result);
 });
 ```
 ### Delete Comment
-```
+```js
 hive.broadcast.deleteComment(wif, author, permlink, function(err, result) {
   console.log(err, result);
 });
 ```
 ### Escrow Dispute
-```
+```js
 hive.broadcast.escrowDispute(wif, from, to, agent, who, escrowId, function(err, result) {
   console.log(err, result);
 });
 ```
 ### Escrow Release
-```
+```js
 hive.broadcast.escrowRelease(wif, from, to, agent, who, receiver, escrowId, hbdAmount, hiveAmount, function(err, result) {
   console.log(err, result);
 });
 ```
 ### Escrow Transfer
-```
+```js
 hive.broadcast.escrowTransfer(wif, from, to, agent, escrowId, hbdAmount, hiveAmount, fee, ratificationDeadline, escrowExpiration, jsonMeta, function(err, result) {
   console.log(err, result);
 });
 ```
+### Get Escrow
+```js
+hive.api.getEscrow(from, escrowId, callback);
+```
+
+|Parameter|Datatype|Description|
+|---------|--------|-----------|
+|from|string|a hive username|
+|escrowId|number|id of the specific escrow transfer|
+|callback|function|function(err, data) {/*code*/}|
+
+
+Call Example:
+```js
+hive.api.getEscrow("username", 23456789, function(err, data) {
+	console.log(err, data);
+});
+```
 ### Feed Publish
 ```
 hive.broadcast.feedPublish(wif, publisher, exchangeRate, function(err, result) {
-- 
GitLab