Skip to content

Commit

Permalink
docs: add clarification to callReadOnlyFunction
Browse files Browse the repository at this point in the history
It is possible to call any public function using `callReadOnlyFunction`, not only those defined with `(define-read-only)`

This commit updates the docstring to make this more clear
  • Loading branch information
mcintyre94 authored and janniks committed May 4, 2022
1 parent 194442c commit 49a094b
Showing 1 changed file with 2 additions and 1 deletion.
3 changes: 2 additions & 1 deletion packages/transactions/src/builders.ts
Original file line number Diff line number Diff line change
Expand Up @@ -1281,7 +1281,8 @@ export interface ReadOnlyFunctionOptions {
}

/**
* Calls a read only function from a contract interface
* Calls a function as read-only from a contract interface
* It is not necessary that the function is defined as read-only in the contract
*
* @param {ReadOnlyFunctionOptions} readOnlyFunctionOptions - the options object
*
Expand Down

1 comment on commit 49a094b

@vercel
Copy link

@vercel vercel bot commented on 49a094b May 4, 2022

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Please sign in to comment.