Merge branch 'v2.3.0_qc_comment' into 'v2.3.0_qc' (merge request !26)

feat: Add comment for sdk interface feat: Add comment for sdk interface --story=0

Merge branch 'v2.3.0_qc_comment' into 'v2.3.0_qc' (merge request !26)
feat: Add comment for sdk interface feat: Add comment for sdk interface --story=0
61fb2db5 · tianle · 768803e3 · 44a7c124 · 61fb2db5
Commit 61fb2db5 authored Aug 25, 2022 by tianle
Hide whitespace changes
Inline Side-by-side

Showing with 7 additions and 6 deletions

sdk/sdk_interface.go sdk/sdk_interface.go +7 -6

No files found.
--- a/sdk/sdk_interface.go
+++ b/sdk/sdk_interface.go
@@ -186,17 +186,18 @@ type SDKInterface interface {
 	// @return1: 根据key, field 生成的历史迭代器
 	// @return2: 获取错误信息
 	NewHistoryKvIterForKey(key, field string) (KeyHistoryKvIter, error)
-	// GetSenderAddr Get the address of the tx sender
-	// @return1: 交易发起方地址
+	// GetSenderAddr Get the address of the origin caller address, same with Origin()
+	// @return1: origin caller address
 	// @return2: 获取错误信息
 	//Deprecated
 	GetSenderAddr() (string, error)
-	// Sender Get the address of the tx sender address
-	// @return1: 交易发起方地址
+	// Sender Get the address of the sender address, if the contract is called by another contract, the result will be
+	// the caller contract's address
+	// @return1: sender address
 	// @return2: 获取错误信息
 	Sender() (string, error)
-	// Origin Get the address of the tx origin address
-	// @return1: 交易
+	// Origin Get the address of the tx origin caller address
+	// @return1: origin caller address
 	// @return2: 获取错误信息
 	Origin() (string, error)
 }