Documentation ¶
Index ¶
- Constants
- Variables
- func ArrayFromStackItem(param stackitem.Item) ([]stackitem.Item, error)
- func BigIntFromStackItem(param stackitem.Item) (*big.Int, error)
- func BoolFromStackItem(param stackitem.Item) (bool, error)
- func BytesFromStackItem(param stackitem.Item) ([]byte, error)
- func CalculateNotaryDepositAmount(c *Client, gasMul, gasDiv int64) (fixedn.Fixed8, error)
- func IntFromStackItem(param stackitem.Item) (int64, error)
- func NNSAlphabetContractName(index int) string
- func StringFromStackItem(param stackitem.Item) (string, error)
- type AlphabetKeys
- type Callback
- type Client
- func (c *Client) BlockCount() (res uint32, err error)
- func (c *Client) CalculateNonceAndVUB(hash util.Uint256) (nonce uint32, vub uint32, err error)
- func (c *Client) Close()
- func (c *Client) Committee() (res keys.PublicKeys, err error)
- func (c *Client) DepositEndlessNotary(amount fixedn.Fixed8) (res util.Uint256, err error)
- func (c *Client) DepositNotary(amount fixedn.Fixed8, delta uint32) (res util.Uint256, err error)
- func (c *Client) EnableNotarySupport(opts ...NotaryOption) error
- func (c *Client) GasBalance() (res int64, err error)
- func (c *Client) GetDesignateHash() util.Uint160
- func (c *Client) GetNotaryDeposit() (res int64, err error)
- func (c *Client) Invoke(contract util.Uint160, fee fixedn.Fixed8, method string, args ...any) error
- func (c *Client) IsNotaryEnabled() bool
- func (c *Client) IsValidScript(script []byte, signers []transaction.Signer) (res bool, err error)
- func (c *Client) MagicNumber() (uint64, error)
- func (c *Client) MsPerBlock() (res int64, err error)
- func (c *Client) NNSContractAddress(name string) (sh util.Uint160, err error)
- func (c *Client) NNSHash() (util.Uint160, error)
- func (c *Client) NeoFSAlphabetList() (res keys.PublicKeys, err error)
- func (c *Client) NotaryInvoke(contract util.Uint160, fee fixedn.Fixed8, nonce uint32, vub *uint32, ...) error
- func (c *Client) NotaryInvokeNotAlpha(contract util.Uint160, fee fixedn.Fixed8, method string, args ...any) error
- func (c *Client) NotarySignAndInvokeTX(mainTx *transaction.Transaction) error
- func (c *Client) NotificationChannel() <-chan rpcclient.Notification
- func (c *Client) ProbeNotary() (res bool)
- func (c *Client) SetGroupSignerScope() error
- func (c *Client) SubscribeForExecutionNotifications(contract util.Uint160) error
- func (c *Client) SubscribeForNewBlocks() error
- func (c *Client) SubscribeForNotaryRequests(txSigner util.Uint160) error
- func (c *Client) TestInvoke(contract util.Uint160, method string, args ...any) (res []stackitem.Item, err error)
- func (c *Client) TransferGas(receiver util.Uint160, amount fixedn.Fixed8) error
- func (c *Client) TxHalt(h util.Uint256) (res bool, err error)
- func (c *Client) TxHeight(h util.Uint256) (res uint32, err error)
- func (c *Client) UnsubscribeAll() error
- func (c *Client) UnsubscribeContract(contract util.Uint160) error
- func (c *Client) UnsubscribeNotaryRequest(signer util.Uint160) error
- func (c *Client) UpdateNeoFSAlphabetList(prm UpdateAlphabetListPrm) error
- func (c *Client) UpdateNotaryList(prm UpdateNotaryListPrm) error
- func (c *Client) Wait(ctx context.Context, n uint32) error
- type Endpoint
- type InvokePrm
- type InvokePrmOptional
- type NotaryOption
- type Option
- func WithConnLostCallback(cb Callback) Option
- func WithContext(ctx context.Context) Option
- func WithDialTimeout(dur time.Duration) Option
- func WithEndpoints(endpoints ...Endpoint) Option
- func WithLogger(logger *logger.Logger) Option
- func WithSigner(signer *transaction.Signer) Option
- func WithSingleClient(cli *rpcclient.WSClient) Option
- func WithSwitchInterval(i time.Duration) Option
- type StaticClient
- type StaticClientOption
- type TestInvokePrm
- type UpdateAlphabetListPrm
- type UpdateNotaryListPrm
Constants ¶
const ( // NNSAuditContractName is a name of the audit contract in NNS. NNSAuditContractName = "audit.frostfs" // NNSBalanceContractName is a name of the balance contract in NNS. NNSBalanceContractName = "balance.frostfs" // NNSContainerContractName is a name of the container contract in NNS. NNSContainerContractName = "container.frostfs" // NNSFrostFSIDContractName is a name of the frostfsid contract in NNS. NNSFrostFSIDContractName = "frostfsid.frostfs" // NNSNetmapContractName is a name of the netmap contract in NNS. NNSNetmapContractName = "netmap.frostfs" // NNSProxyContractName is a name of the proxy contract in NNS. NNSProxyContractName = "proxy.frostfs" // NNSReputationContractName is a name of the reputation contract in NNS. NNSReputationContractName = "reputation.frostfs" // NNSSubnetworkContractName is a name of the subnet contract in NNS. NNSSubnetworkContractName = "subnet.frostfs" // NNSGroupKeyName is a name for the FrostFS group key record in NNS. NNSGroupKeyName = "group.frostfs" )
const HaltState = "HALT"
HaltState returned if TestInvoke function processed without panic.
Variables ¶
var ( // ErrNilClient is returned by functions that expect // a non-nil Client pointer, but received nil. ErrNilClient = errors.New("client is nil") // ErrConnectionLost is returned when client lost web socket connection // to the RPC node and has not been able to establish a new one since. ErrConnectionLost = errors.New("connection to the RPC node has been lost") )
var ( // ErrNNSRecordNotFound means that there is no such record in NNS contract. ErrNNSRecordNotFound = errors.New("record has not been found in NNS contract") )
Functions ¶
func ArrayFromStackItem ¶
ArrayFromStackItem returns the slice contract parameters from passed parameter.
If passed parameter carries boolean false value, (nil, nil) returns.
func BigIntFromStackItem ¶
BigIntFromStackItem receives numerical value from the value of a smart contract parameter.
func BoolFromStackItem ¶
BoolFromStackItem receives boolean value from the value of a smart contract parameter.
func BytesFromStackItem ¶
BytesFromStackItem receives binary value from the value of a smart contract parameter.
func CalculateNotaryDepositAmount ¶
CalculateNotaryDepositAmount calculates notary deposit amount using the rule:
IF notaryBalance < gasBalance * gasMul { DEPOSIT gasBalance / gasDiv } ELSE { DEPOSIT 1 }
gasMul and gasDiv must be positive.
func IntFromStackItem ¶
IntFromStackItem receives numerical value from the value of a smart contract parameter.
func NNSAlphabetContractName ¶
NNSAlphabetContractName returns contract name of the alphabet contract in NNS based on alphabet index.
Types ¶
type AlphabetKeys ¶
type AlphabetKeys func() (keys.PublicKeys, error)
type Callback ¶
type Callback func()
Callback is a function that is going to be called on certain Client's state.
type Client ¶
type Client struct {
// contains filtered or unexported fields
}
Client is a wrapper over web socket neo-go client that provides smart-contract invocation interface and notification subscription functionality.
On connection lost tries establishing new connection to the next RPC (if any). If no RPC node available, switches to inactive mode: any RPC call leads to immediate return with ErrConnectionLost error, notification channel returned from Client.NotificationChannel is closed.
Working client must be created via constructor New. Using the Client that has been created with new(Client) expression (or just declaring a Client variable) is unsafe and can lead to panic.
func New ¶
func New(key *keys.PrivateKey, opts ...Option) (*Client, error)
New creates, initializes and returns the Client instance. Notary support should be enabled with EnableNotarySupport client method separately.
If private key is nil, it panics.
Other values are set according to provided options, or by default:
- client context: Background;
- dial timeout: 5s;
- blockchain network type: netmode.PrivNet;
- signer with the global scope;
- wait interval: 500ms;
- logger: &logger.Logger{Logger: zap.L()}.
If desired option satisfies the default value, it can be omitted. If multiple options of the same config value are supplied, the option with the highest index in the arguments will be used.
func (*Client) BlockCount ¶
BlockCount returns block count of the network to which the underlying RPC node client is connected.
func (*Client) CalculateNonceAndVUB ¶
CalculateNonceAndVUB calculates nonce and ValidUntilBlock values based on transaction hash.
func (*Client) Close ¶
func (c *Client) Close()
Close closes connection to the remote side making this client instance unusable. Closes notification channel returned from Client.NotificationChannel(), Removes all subscription.
func (*Client) Committee ¶
func (c *Client) Committee() (res keys.PublicKeys, err error)
Committee returns keys of chain committee from neo native contract.
func (*Client) DepositEndlessNotary ¶
DepositEndlessNotary calls notary deposit method. Unlike `DepositNotary`, this method sets notary deposit till parameter to a maximum possible value. This allows to avoid ValidAfterDeposit failures.
This function must be invoked with notary enabled otherwise it throws panic.
func (*Client) DepositNotary ¶
DepositNotary calls notary deposit method. Deposit is required to operate with notary contract. It used by notary contract in to produce fallback tx if main tx failed to create. Deposit isn't last forever, so it should be called periodically. Notary support should be enabled in client to use this function.
This function must be invoked with notary enabled otherwise it throws panic.
func (*Client) EnableNotarySupport ¶
func (c *Client) EnableNotarySupport(opts ...NotaryOption) error
EnableNotarySupport creates notary structure in client that provides ability for client to get alphabet keys from committee or provided source and use proxy contract script hash to create tx for notary contract.
func (*Client) GasBalance ¶
GasBalance returns GAS amount in the client's wallet.
func (*Client) GetDesignateHash ¶
GetDesignateHash returns hash of the native `RoleManagement` contract.
func (*Client) GetNotaryDeposit ¶
GetNotaryDeposit returns deposit of client's account in notary contract. Notary support should be enabled in client to use this function.
This function must be invoked with notary enabled otherwise it throws panic.
func (*Client) Invoke ¶
Invoke invokes contract method by sending transaction into blockchain. Supported args types: int64, string, util.Uint160, []byte and bool.
func (*Client) IsNotaryEnabled ¶
IsNotaryEnabled returns true if EnableNotarySupport has been successfully called before.
func (*Client) IsValidScript ¶
IsValidScript returns true if invocation script executes with HALT state.
func (*Client) MagicNumber ¶
MagicNumber returns the magic number of the network to which the underlying RPC node client is connected.
func (*Client) MsPerBlock ¶
MsPerBlock returns MillisecondsPerBlock network parameter.
func (*Client) NNSContractAddress ¶
NNSContractAddress returns contract address script hash based on its name in NNS contract. If script hash has not been found, returns ErrNNSRecordNotFound.
func (*Client) NeoFSAlphabetList ¶
func (c *Client) NeoFSAlphabetList() (res keys.PublicKeys, err error)
NeoFSAlphabetList returns keys that stored in NeoFS Alphabet role. Main chain stores alphabet node keys of inner ring there, however the sidechain stores both alphabet and non alphabet node keys of inner ring.
func (*Client) NotaryInvoke ¶
func (c *Client) NotaryInvoke(contract util.Uint160, fee fixedn.Fixed8, nonce uint32, vub *uint32, method string, args ...any) error
NotaryInvoke invokes contract method by sending tx to notary contract in blockchain. Fallback tx is a `RET`. If Notary support is not enabled it fallbacks to a simple `Invoke()`.
`nonce` and `vub` are used only if notary is enabled.
func (*Client) NotaryInvokeNotAlpha ¶
func (c *Client) NotaryInvokeNotAlpha(contract util.Uint160, fee fixedn.Fixed8, method string, args ...any) error
NotaryInvokeNotAlpha does the same as NotaryInvoke but does not use client's private key in Invocation script. It means that main TX of notary request is not expected to be signed by the current node.
Considered to be used by non-IR nodes.
func (*Client) NotarySignAndInvokeTX ¶
func (c *Client) NotarySignAndInvokeTX(mainTx *transaction.Transaction) error
NotarySignAndInvokeTX signs and sends notary request that was received from Notary service. NOTE: does not fallback to simple `Invoke()`. Expected to be used only for TXs retrieved from the received notary requests.
func (*Client) NotificationChannel ¶
func (c *Client) NotificationChannel() <-chan rpcclient.Notification
NotificationChannel returns channel than receives subscribed notification from the connected RPC node. Channel is closed when connection to the RPC node has been lost without the possibility of recovery.
func (*Client) ProbeNotary ¶
ProbeNotary checks if native `Notary` contract is presented on chain.
func (*Client) SetGroupSignerScope ¶
SetGroupSignerScope makes the default signer scope include all FrostFS contracts. Should be called for side-chain client only.
func (*Client) SubscribeForExecutionNotifications ¶
SubscribeForExecutionNotifications adds subscription for notifications generated during contract transaction execution to this instance of client.
Returns ErrConnectionLost if client has not been able to establish connection to any of passed RPC endpoints.
func (*Client) SubscribeForNewBlocks ¶
SubscribeForNewBlocks adds subscription for new block events to this instance of client.
Returns ErrConnectionLost if client has not been able to establish connection to any of passed RPC endpoints.
func (*Client) SubscribeForNotaryRequests ¶
SubscribeForNotaryRequests adds subscription for notary request payloads addition or removal events to this instance of client. Passed txSigner is used as filter: subscription is only for the notary requests that must be signed by txSigner.
Returns ErrConnectionLost if client has not been able to establish connection to any of passed RPC endpoints.
func (*Client) TestInvoke ¶
func (c *Client) TestInvoke(contract util.Uint160, method string, args ...any) (res []stackitem.Item, err error)
TestInvoke invokes contract method locally in neo-go node. This method should be used to read data from smart-contract.
func (*Client) TransferGas ¶
TransferGas to the receiver from local wallet.
func (*Client) TxHalt ¶
TxHalt returns true if transaction has been successfully executed and persisted.
func (*Client) TxHeight ¶
TxHeight returns true if transaction has been successfully executed and persisted.
func (*Client) UnsubscribeAll ¶
UnsubscribeAll removes all active subscriptions of current client.
Returns ErrConnectionLost if client has not been able to establish connection to any of passed RPC endpoints.
func (*Client) UnsubscribeContract ¶
UnsubscribeContract removes subscription for given contract event stream.
Returns ErrConnectionLost if client has not been able to establish connection to any of passed RPC endpoints.
func (*Client) UnsubscribeNotaryRequest ¶
UnsubscribeNotaryRequest removes subscription for given notary requests signer.
Returns ErrConnectionLost if client has not been able to establish connection to any of passed RPC endpoints.
func (*Client) UpdateNeoFSAlphabetList ¶
func (c *Client) UpdateNeoFSAlphabetList(prm UpdateAlphabetListPrm) error
UpdateNeoFSAlphabetList updates list of alphabet nodes in designate contract. As for sidechain list should contain all inner ring nodes. Requires committee multi signature.
This function must be invoked with notary enabled otherwise it throws panic.
func (*Client) UpdateNotaryList ¶
func (c *Client) UpdateNotaryList(prm UpdateNotaryListPrm) error
UpdateNotaryList updates list of notary nodes in designate contract. Requires committee multi signature.
This function must be invoked with notary enabled otherwise it throws panic.
type InvokePrm ¶
type InvokePrm struct { TestInvokePrm // optional parameters InvokePrmOptional }
InvokePrm groups parameters of the Invoke operation.
type InvokePrmOptional ¶
type InvokePrmOptional struct {
// contains filtered or unexported fields
}
InvokePrmOptional groups optional parameters of the Invoke operation.
func (*InvokePrmOptional) SetHash ¶
func (i *InvokePrmOptional) SetHash(hash util.Uint256)
SetHash sets optional hash of the transaction. If hash is set and notary is enabled, StaticClient uses it for notary nonce and `validUntilBlock` calculation.
type NotaryOption ¶
type NotaryOption func(*notaryCfg)
func WithAlphabetSource ¶
func WithAlphabetSource(t AlphabetKeys) NotaryOption
WithAlphabetSource returns a notary support option for client that specifies function to return list of alphabet node keys. By default notary subsystem uses committee as a source. This is valid for side chain but notary in main chain should override it.
func WithFallbackTime ¶
func WithFallbackTime(t uint32) NotaryOption
WithFallbackTime returns a notary support option for client that specifies amount of blocks before fallbackTx will be sent. Should be less than TxValidTime.
func WithProxyContract ¶
func WithProxyContract(h util.Uint160) NotaryOption
WithProxyContract sets proxy contract hash.
func WithRoundTime ¶
func WithRoundTime(t uint32) NotaryOption
WithRoundTime returns a notary support option for client that specifies extra blocks to synchronize side chain height diff of inner ring nodes.
func WithTxValidTime ¶
func WithTxValidTime(t uint32) NotaryOption
WithTxValidTime returns a notary support option for client that specifies minimum amount of blocks when mainTx will be valid.
type Option ¶
type Option func(*cfg)
Option is a client configuration change function.
func WithConnLostCallback ¶
WithConnLostCallback return a client constructor option that specifies a callback that is called when Client unsuccessfully tried to connect to all the specified endpoints.
func WithContext ¶
WithContext returns a client constructor option that specifies the neo-go client context.
Ignores nil value. Has no effect if WithSingleClient is provided.
If option not provided, context.Background() is used.
func WithDialTimeout ¶
WithDialTimeout returns a client constructor option that specifies neo-go client dial timeout duration.
Ignores non-positive value. Has no effect if WithSingleClient is provided.
If option not provided, 5s timeout is used.
func WithEndpoints ¶
WithEndpoints returns a client constructor option that specifies additional Neo rpc endpoints.
func WithLogger ¶
WithLogger returns a client constructor option that specifies the component for writing log messages.
Ignores nil value.
If option not provided, &logger.Logger{Logger: zap.L()} is used.
func WithSigner ¶
func WithSigner(signer *transaction.Signer) Option
WithSigner returns a client constructor option that specifies the signer and the scope of the transaction.
Ignores nil value.
If option not provided, signer with global scope is used.
func WithSingleClient ¶
WithSingleClient returns a client constructor option that specifies single neo-go client and forces Client to use it for requests.
Passed client must already be initialized.
func WithSwitchInterval ¶
WithSwitchInterval returns a client constructor option that specifies a wait interval b/w attempts to reconnect to an RPC node with the highest priority.
type StaticClient ¶
type StaticClient struct {
// contains filtered or unexported fields
}
StaticClient is a wrapper over Neo:Morph client that invokes single smart contract methods with fixed fee.
Working static client must be created via constructor NewStatic. Using the StaticClient that has been created with new(StaticClient) expression (or just declaring a StaticClient variable) is unsafe and can lead to panic.
func NewStatic ¶
func NewStatic(client *Client, scriptHash util.Uint160, fee fixedn.Fixed8, opts ...StaticClientOption) (*StaticClient, error)
NewStatic creates, initializes and returns the StaticClient instance.
If provided Client instance is nil, ErrNilClient is returned.
Specified fee is used by default. Per-operation fees can be customized via WithCustomFee option.
func (StaticClient) ContractAddress ¶
func (s StaticClient) ContractAddress() util.Uint160
ContractAddress returns the address of the associated contract.
func (StaticClient) Invoke ¶
func (s StaticClient) Invoke(prm InvokePrm) error
Invoke calls Invoke method of Client with static internal script hash and fee. Supported args types are the same as in Client.
If TryNotary is provided:
- if AsAlphabet is provided, calls NotaryInvoke;
- otherwise, calls NotaryInvokeNotAlpha.
If fee for the operation executed using specified method is customized, then StaticClient uses it. Otherwise, default fee is used.
func (*StaticClient) IsAlpha ¶
func (s *StaticClient) IsAlpha() bool
IsAlpha returns Alphabet status of the client.
See also AsAlphabet.
func (StaticClient) Morph ¶
func (s StaticClient) Morph() *Client
Morph return wrapped raw morph client.
func (StaticClient) TestInvoke ¶
func (s StaticClient) TestInvoke(prm TestInvokePrm) ([]stackitem.Item, error)
TestInvoke calls TestInvoke method of Client with static internal script hash.
func (*StaticClient) WithNotary ¶
func (s *StaticClient) WithNotary() bool
WithNotary returns notary status of the client.
See also TryNotary.
type StaticClientOption ¶
type StaticClientOption func(*staticOpts)
StaticClientOption allows to set an optional parameter of StaticClient.
func AsAlphabet ¶
func AsAlphabet() StaticClientOption
AsAlphabet returns option to sign main TX of notary requests with client's private key.
Considered to be used by IR nodes only.
func TryNotary ¶
func TryNotary() StaticClientOption
TryNotary returns option to enable notary invocation tries.
func WithCustomFee ¶
func WithCustomFee(method string, fee fixedn.Fixed8) StaticClientOption
WithCustomFee returns option to specify custom fee for the operation executed using specified contract method.
type TestInvokePrm ¶
type TestInvokePrm struct {
// contains filtered or unexported fields
}
TestInvokePrm groups parameters of the TestInvoke operation.
func (*TestInvokePrm) SetArgs ¶
func (ti *TestInvokePrm) SetArgs(args ...any)
SetArgs sets arguments of the contact call.
func (*TestInvokePrm) SetMethod ¶
func (ti *TestInvokePrm) SetMethod(method string)
SetMethod sets method of the contract to call.
type UpdateAlphabetListPrm ¶
type UpdateAlphabetListPrm struct {
// contains filtered or unexported fields
}
UpdateAlphabetListPrm groups parameters of UpdateNeoFSAlphabetList operation.
func (*UpdateAlphabetListPrm) SetHash ¶
func (u *UpdateAlphabetListPrm) SetHash(hash util.Uint256)
SetHash sets hash of the transaction that led to the update of the alphabet role in the designate contract.
func (*UpdateAlphabetListPrm) SetList ¶
func (u *UpdateAlphabetListPrm) SetList(list keys.PublicKeys)
SetList sets a list of the new alphabet role keys.
type UpdateNotaryListPrm ¶
type UpdateNotaryListPrm struct {
// contains filtered or unexported fields
}
UpdateNotaryListPrm groups parameters of UpdateNotaryList operation.
func (*UpdateNotaryListPrm) SetHash ¶
func (u *UpdateNotaryListPrm) SetHash(hash util.Uint256)
SetHash sets hash of the transaction that led to the update of the notary role in the designate contract.
func (*UpdateNotaryListPrm) SetList ¶
func (u *UpdateNotaryListPrm) SetList(list keys.PublicKeys)
SetList sets a list of the new notary role keys.