Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Tiny documentation improvements #3666

Merged
merged 2 commits into from
Nov 7, 2024
+16 −6
Merged

Tiny documentation improvements #3666

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
24577d3
rpcclient: improve GetNEPXXTransfers docs
roman-khimov Nov 7, 2024
9cca702
emit: add some package doc
roman-khimov Nov 7, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
14 changes: 8 additions & 6 deletions pkg/rpcclient/rpc.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -333,8 +333,10 @@ func (c *Client) GetNEP11Properties(asset util.Uint160, token []byte) (map[strin
}

// GetNEP11Transfers is a wrapper for getnep11transfers RPC. Address parameter
// is mandatory, while all others are optional. Limit and page parameters are
// only supported by NeoGo servers and can only be specified with start and stop.
// is mandatory, while all others are optional. start and stop parameters are
// timestamps in milliseconds (just like block timestamps are). limit and page
// parameters are only supported by NeoGo servers and can only be specified
// with start and stop (since they're positional in the protocol).
func (c *Client) GetNEP11Transfers(address util.Uint160, start, stop *uint64, limit, page *int) (*result.NEP11Transfers, error) {
params, err := packTransfersParams(address, start, stop, limit, page)
if err != nil {
Expand Down Expand Up @@ -371,10 +373,10 @@ func packTransfersParams(address util.Uint160, start, stop *uint64, limit, page
}

// GetNEP17Transfers is a wrapper for getnep17transfers RPC. Address parameter
// is mandatory while all the others are optional. Start and stop parameters
// are supported since neo-go 0.77.0 and limit and page since neo-go 0.78.0.
// These parameters are positional in the JSON-RPC call. For example, you can't specify the limit
// without specifying start/stop first.
// is mandatory while all the others are optional. start and stop parameters
// are timestamps in milliseconds (just like block timestamps are). limit and page
// parameters are only supported by NeoGo servers and can only be specified
// with start and stop (since they're positional in the protocol).
func (c *Client) GetNEP17Transfers(address util.Uint160, start, stop *uint64, limit, page *int) (*result.NEP17Transfers, error) {
params, err := packTransfersParams(address, start, stop, limit, page)
if err != nil {
Expand Down
8 changes: 8 additions & 0 deletions pkg/vm/emit/emit.go
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,3 +1,11 @@
/*
Package emit implements low-level functions for Neo VM script creation.
This package is not intended to be used by applications directly, see
smartcontract package for more convenient ways to create standard and
well-known scripts. Use this package only if you can't create the script
you need in any other way.
*/
package emit

import (
Expand Down
Loading