package
0.43.0
Repository: https://github.com/nspcc-dev/neofs-node.git
Documentation: pkg.go.dev

# Packages

No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author

# Functions

ArrayFromStackItem returns the slice contract parameters from passed parameter.
AsAlphabet returns option to sign main TX of notary requests with client's private key.
BigIntFromStackItem receives numerical value from the value of a smart contract parameter.
BoolFromStackItem receives boolean value from the value of a smart contract parameter.
BytesFromStackItem receives binary value from the value of a smart contract parameter.
CalculateNotaryDepositAmount calculates notary deposit amount using the rule: IF notaryBalance < gasBalance * gasMul { DEPOSIT gasBalance / gasDiv } ELSE { DEPOSIT 1 } gasMul and gasDiv must be positive.
GetUniversalSignerScope returns a universal (applicable for any valid NeoFS contract call) scope that should be used by IR and SNs.
IntFromStackItem receives numerical value from the value of a smart contract parameter.
New creates, initializes and returns the Client instance.
NewStatic creates, initializes and returns the StaticClient instance.
NNSAlphabetContractName returns contract name of the alphabet contract in NNS based on alphabet index.
StringFromStackItem receives string value from the value of a smart contract parameter.
TryNotary returns option to enable notary invocation tries.
WithAlphabetSource returns a notary support option for client that specifies function to return list of alphabet node keys.
WithAutoSidechainScope returns a client constructor option that sets automatic transaction scope detection to true which overrides the default CalledByEntry to a set of Rules made specifically for the sidechain.
WithConnLostCallback return a client constructor option that specifies a callback that is called when Client unsuccessfully tried to connect to all the specified endpoints.
WithConnSwitchCallback returns a client constructor option that specifies a callback that is called when the Client reconnected to a new RPC (from [WithEndpoints] list) successfully.
WithContext returns a client constructor option that specifies the neo-go client context.
WithCustomFee returns option to specify custom fee for the operation executed using specified contract method.
WithDialTimeout returns a client constructor option that specifies neo-go client dial timeout duration.
WithEndpoints returns a client constructor option that specifies Neo rpc endpoints.
WithLogger returns a client constructor option that specifies the component for writing log messages.
WithMinRequiredBlockHeight returns a client constructor option that specifies a minimal chain height that is considered as acceptable.
WithProxyContract sets proxy contract hash.
WithReconnectionRetries returns a client constructor option that specifies number of reconnection attempts (through the full list provided via [WithEndpoints]) before RPC connection is considered lost.
WithReconnectionsDelay returns a client constructor option that specifies delays b/w reconnections.
WithRoundTime returns a notary support option for client that specifies extra blocks to synchronize side chain height diff of inner ring nodes.
WithSingleClient returns a client constructor option that specifies single neo-go client and forces Client to use it for requests.
WithTxValidTime returns a notary support option for client that specifies minimum amount of blocks when mainTx will be valid.

# Constants

HaltState returned if TestInvoke function processed without panic.
NNSAuditContractName is a name of the audit contract in NNS.
NNSBalanceContractName is a name of the balance contract in NNS.
NNSContainerContractName is a name of the container contract in NNS.
NNSNeoFSIDContractName is a name of the neofsid contract in NNS.
NNSNetmapContractName is a name of the netmap contract in NNS.
NNSProxyContractName is a name of the proxy contract in NNS.
NNSReputationContractName is a name of the reputation contract in NNS.

# Variables

ErrConnectionLost is returned when client lost web socket connection to the RPC node and has not been able to establish a new one since.
ErrNilClient is returned by functions that expect a non-nil Client pointer, but received nil.
ErrNNSRecordNotFound means that there is no such record in NNS contract.
ErrStaleNodes is returned from [New] when minimal required height requirement specified in [WithMinRequiredBlockHeight] is not satisfied by the given nodes.

# Structs

Client is a wrapper over web socket neo-go client that provides smart-contract invocation interface and notification subscription functionality.
Endpoint represents morph endpoint together with its priority.
InvokePrm groups parameters of the Invoke operation.
InvokePrmOptional groups optional parameters of the Invoke operation.
StaticClient is a wrapper over Neo:Morph client that invokes single smart contract methods with fixed fee.
TestInvokePrm groups parameters of the TestInvoke operation.
UpdateAlphabetListPrm groups parameters of UpdateNeoFSAlphabetList operation.
UpdateNotaryListPrm groups parameters of UpdateNotaryList operation.

# Type aliases

No description provided by the author
Callback is a function that is going to be called on certain Client's state.
No description provided by the author
Option is a client configuration change function.
StaticClientOption allows to set an optional parameter of StaticClient.