Documentation ¶
Overview ¶
Package neofs contains implementation of NeoFS contract deployed in NeoFS mainchain.
NeoFS contract is an entry point to NeoFS users. This contract stores all NeoFS related GAS, registers new Inner Ring candidates and produces notifications to control the sidechain.
While mainchain committee controls the list of Alphabet nodes in native RoleManagement contract, NeoFS can't change more than 1\3 keys at a time. NeoFS contract contains the actual list of Alphabet nodes in the sidechain.
Network configuration is also stored in NeoFS contract. All changes in configuration are mirrored in the sidechain with notifications.
Contract notifications ¶
Deposit notification. This notification is produced when user transfers native GAS to the NeoFS contract address. The same amount of NEOFS token will be minted in Balance contract in the sidechain.
Deposit: - name: from type: Hash160 - name: amount type: Integer - name: receiver type: Hash160 - name: txHash type: Hash256
Withdraw notification. This notification is produced when a user wants to withdraw GAS from the internal NeoFS balance and has paid fee for that.
Withdraw: - name: user type: Hash160 - name: amount type: Integer - name: txHash type: Hash256
Cheque notification. This notification is produced when NeoFS contract has successfully transferred assets back to the user after withdraw.
Cheque: - name: id type: ByteArray - name: user type: Hash160 - name: amount type: Integer - name: lockAccount type: ByteArray
Bind notification. This notification is produced when a user wants to bind public keys with the user account (OwnerID). Keys argument is an array of ByteArray.
Bind: - name: user type: ByteArray - name: keys type: Array
Unbind notification. This notification is produced when a user wants to unbind public keys with the user account (OwnerID). Keys argument is an array of ByteArray.
Unbind: - name: user type: ByteArray - name: keys type: Array
AlphabetUpdate notification. This notification is produced when Alphabet nodes have updated their lists in the contract. Alphabet argument is an array of ByteArray. It contains public keys of new alphabet nodes.
AlphabetUpdate: - name: id type: ByteArray - name: alphabet type: Array
SetConfig notification. This notification is produced when Alphabet nodes update NeoFS network configuration value.
SetConfig - name: id type: ByteArray - name: key type: ByteArray - name: value type: ByteArray
Index ¶
- Constants
- func AlphabetAddress() interop.Hash160
- func AlphabetList() []common.IRNode
- func AlphabetUpdate(id []byte, args []interop.PublicKey)
- func Bind(user []byte, keys []interop.PublicKey)
- func Cheque(id []byte, user interop.Hash160, amount int, lockAcc []byte)
- func Config(key []byte) any
- func InnerRingCandidateAdd(key interop.PublicKey)
- func InnerRingCandidateRemove(key interop.PublicKey)
- func InnerRingCandidates() []common.IRNode
- func OnNEP17Payment(from interop.Hash160, amount int, data any)
- func SetConfig(id, key, val []byte)
- func Unbind(user []byte, keys []interop.PublicKey)
- func Update(script []byte, manifest []byte, data any)
- func Version() int
- func Withdraw(user interop.Hash160, amount int)
- type Record
Constants ¶
const (
// CandidateFeeConfigKey contains fee for a candidate registration.
CandidateFeeConfigKey = "InnerRingCandidateFee"
)
Variables ¶
This section is empty.
Functions ¶
func AlphabetAddress ¶ added in v0.7.0
AlphabetAddress returns 2\3n+1 multisignature address of alphabet nodes. It is used in sidechain notary disabled environment.
func AlphabetList ¶ added in v0.6.0
AlphabetList returns an array of alphabet node keys. It is used in sidechain notary disabled environment.
func AlphabetUpdate ¶ added in v0.6.0
AlphabetUpdate updates a list of alphabet nodes with the provided list of public keys. It can be invoked only by alphabet nodes.
This method is used in notary disabled sidechain environment. In this case, the actual alphabet list should be stored in the NeoFS contract.
func Bind ¶
Bind method produces notification to bind the specified public keys in NeoFSID contract in the sidechain. It can be invoked only by specified user.
This method produces Bind notification. This method panics if keys are not 33 byte long. User argument must be a valid 20 byte script hash.
func Cheque ¶
Cheque transfers GAS back to the user from the contract account, if assets were successfully locked in NeoFS balance contract. It can be invoked only by Alphabet nodes.
This method produces Cheque notification to burn assets in sidechain.
func Config ¶
Config returns configuration value of NeoFS configuration. If the key does not exist, returns nil.
func InnerRingCandidateAdd ¶
InnerRingCandidateAdd adds a key to a list of Inner Ring candidates. It can be invoked only by the candidate itself.
This method transfers fee from a candidate to the contract account. Fee value is specified in NeoFS network config with the key InnerRingCandidateFee.
func InnerRingCandidateRemove ¶
InnerRingCandidateRemove removes a key from a list of Inner Ring candidates. It can be invoked by Alphabet nodes or the candidate itself.
This method does not return fee back to the candidate.
func InnerRingCandidates ¶
InnerRingCandidates returns an array of structures that contain an Inner Ring candidate node key.
func OnNEP17Payment ¶ added in v0.4.0
OnNEP17Payment is a callback for NEP-17 compatible native GAS contract. It takes no more than 9000.0 GAS. Native GAS has precision 8, and NeoFS balance contract has precision 12. Values bigger than 9000.0 can break JSON limits for integers when precision is converted.
func SetConfig ¶
func SetConfig(id, key, val []byte)
SetConfig key-value pair as a NeoFS runtime configuration value. It can be invoked only by Alphabet nodes.
func Unbind ¶
Unbind method produces notification to unbind the specified public keys in NeoFSID contract in the sidechain. It can be invoked only by the specified user.
This method produces Unbind notification. This method panics if keys are not 33 byte long. User argument must be a valid 20 byte script hash.
func Update ¶ added in v0.11.0
Update method updates contract source code and manifest. It can be invoked only by sidechain committee.
func Withdraw ¶
Withdraw initializes gas asset withdraw from NeoFS. It can be invoked only by the specified user.
This method produces Withdraw notification to lock assets in the sidechain and transfers withdraw fee from a user account to each Alphabet node. If notary is enabled in the mainchain, fee is transferred to Processing contract. Fee value is specified in NeoFS network config with the key WithdrawFee.