/* Package policy allows to work with the native PolicyContract contract via RPC. Safe methods are encapsulated into ContractReader structure while Contract provides various methods to perform PolicyContract state-changing calls. */ package policy import ( "github.com/nspcc-dev/neo-go/pkg/core/native/nativehashes" "github.com/nspcc-dev/neo-go/pkg/core/transaction" "github.com/nspcc-dev/neo-go/pkg/neorpc/result" "github.com/nspcc-dev/neo-go/pkg/rpcclient/unwrap" "github.com/nspcc-dev/neo-go/pkg/smartcontract" "github.com/nspcc-dev/neo-go/pkg/util" ) // Invoker is used by ContractReader to call various methods. type Invoker interface { Call(contract util.Uint160, operation string, params ...any) (*result.Invoke, error) } // Actor is used by Contract to create and send transactions. type Actor interface { Invoker MakeCall(contract util.Uint160, method string, params ...any) (*transaction.Transaction, error) MakeRun(script []byte) (*transaction.Transaction, error) MakeUnsignedCall(contract util.Uint160, method string, attrs []transaction.Attribute, params ...any) (*transaction.Transaction, error) MakeUnsignedRun(script []byte, attrs []transaction.Attribute) (*transaction.Transaction, error) SendCall(contract util.Uint160, method string, params ...any) (util.Uint256, uint32, error) SendRun(script []byte) (util.Uint256, uint32, error) } // Hash stores the hash of the native PolicyContract contract. var Hash = nativehashes.PolicyContract const ( execFeeSetter = "setExecFeeFactor" feePerByteSetter = "setFeePerByte" storagePriceSetter = "setStoragePrice" attributeFeeSetter = "setAttributeFee" ) // ContractReader provides an interface to call read-only PolicyContract // contract's methods. type ContractReader struct { invoker Invoker } // Contract represents a PolicyContract contract client that can be used to // invoke all of its methods. type Contract struct { ContractReader actor Actor } // NewReader creates an instance of ContractReader that can be used to read // data from the contract. func NewReader(invoker Invoker) *ContractReader { return &ContractReader{invoker} } // New creates an instance of Contract to perform actions using // the given Actor. Notice that PolicyContract's state can be changed // only by the network's committee, so the Actor provided must be a committee // actor for all methods to work properly. func New(actor Actor) *Contract { return &Contract{*NewReader(actor), actor} } // GetExecFeeFactor returns current execution fee factor used by the network. // This setting affects all executions of all transactions. func (c *ContractReader) GetExecFeeFactor() (int64, error) { return unwrap.Int64(c.invoker.Call(Hash, "getExecFeeFactor")) } // GetFeePerByte returns current minimal per-byte network fee value which // affects all transactions on the network. func (c *ContractReader) GetFeePerByte() (int64, error) { return unwrap.Int64(c.invoker.Call(Hash, "getFeePerByte")) } // GetStoragePrice returns current per-byte storage price. Any contract saving // data to the storage pays for it according to this value. func (c *ContractReader) GetStoragePrice() (int64, error) { return unwrap.Int64(c.invoker.Call(Hash, "getStoragePrice")) } // GetAttributeFee returns current fee for the specified attribute usage. Any // contract saving data to the storage pays for it according to this value. func (c *ContractReader) GetAttributeFee(t transaction.AttrType) (int64, error) { return unwrap.Int64(c.invoker.Call(Hash, "getAttributeFee", byte(t))) } // IsBlocked checks if the given account is blocked in the PolicyContract. func (c *ContractReader) IsBlocked(account util.Uint160) (bool, error) { return unwrap.Bool(c.invoker.Call(Hash, "isBlocked", account)) } // SetExecFeeFactor creates and sends a transaction that sets the new // execution fee factor for the network to use. The action is successful when // transaction ends in HALT state. The returned values are transaction hash, its // ValidUntilBlock value and an error if any. func (c *Contract) SetExecFeeFactor(value int64) (util.Uint256, uint32, error) { return c.actor.SendCall(Hash, execFeeSetter, value) } // SetExecFeeFactorTransaction creates a transaction that sets the new execution // fee factor. This transaction is signed, but not sent to the network, // instead it's returned to the caller. func (c *Contract) SetExecFeeFactorTransaction(value int64) (*transaction.Transaction, error) { return c.actor.MakeCall(Hash, execFeeSetter, value) } // SetExecFeeFactorUnsigned creates a transaction that sets the new execution // fee factor. This transaction is not signed and just returned to the caller. func (c *Contract) SetExecFeeFactorUnsigned(value int64) (*transaction.Transaction, error) { return c.actor.MakeUnsignedCall(Hash, execFeeSetter, nil, value) } // SetFeePerByte creates and sends a transaction that sets the new minimal // per-byte network fee value. The action is successful when transaction ends in // HALT state. The returned values are transaction hash, its ValidUntilBlock // value and an error if any. func (c *Contract) SetFeePerByte(value int64) (util.Uint256, uint32, error) { return c.actor.SendCall(Hash, feePerByteSetter, value) } // SetFeePerByteTransaction creates a transaction that sets the new minimal // per-byte network fee value. This transaction is signed, but not sent to the // network, instead it's returned to the caller. func (c *Contract) SetFeePerByteTransaction(value int64) (*transaction.Transaction, error) { return c.actor.MakeCall(Hash, feePerByteSetter, value) } // SetFeePerByteUnsigned creates a transaction that sets the new minimal per-byte // network fee value. This transaction is not signed and just returned to the // caller. func (c *Contract) SetFeePerByteUnsigned(value int64) (*transaction.Transaction, error) { return c.actor.MakeUnsignedCall(Hash, feePerByteSetter, nil, value) } // SetStoragePrice creates and sends a transaction that sets the storage price // for contracts. The action is successful when transaction ends in HALT // state. The returned values are transaction hash, its ValidUntilBlock value // and an error if any. func (c *Contract) SetStoragePrice(value int64) (util.Uint256, uint32, error) { return c.actor.SendCall(Hash, storagePriceSetter, value) } // SetStoragePriceTransaction creates a transaction that sets the storage price // for contracts. This transaction is signed, but not sent to the network, // instead it's returned to the caller. func (c *Contract) SetStoragePriceTransaction(value int64) (*transaction.Transaction, error) { return c.actor.MakeCall(Hash, storagePriceSetter, value) } // SetStoragePriceUnsigned creates a transaction that sets the storage price // for contracts. This transaction is not signed and just returned to the // caller. func (c *Contract) SetStoragePriceUnsigned(value int64) (*transaction.Transaction, error) { return c.actor.MakeUnsignedCall(Hash, storagePriceSetter, nil, value) } // SetAttributeFee creates and sends a transaction that sets the new attribute // fee value for the specified attribute. The action is successful when // transaction ends in HALT state. The returned values are transaction hash, its // ValidUntilBlock value and an error if any. func (c *Contract) SetAttributeFee(t transaction.AttrType, value int64) (util.Uint256, uint32, error) { return c.actor.SendCall(Hash, attributeFeeSetter, byte(t), value) } // SetAttributeFeeTransaction creates a transaction that sets the new attribute // fee value for the specified attribute. This transaction is signed, but not // sent to the network, instead it's returned to the caller. func (c *Contract) SetAttributeFeeTransaction(t transaction.AttrType, value int64) (*transaction.Transaction, error) { return c.actor.MakeCall(Hash, attributeFeeSetter, byte(t), value) } // SetAttributeFeeUnsigned creates a transaction that sets the new attribute fee // value for the specified attribute. This transaction is not signed and just // returned to the caller. func (c *Contract) SetAttributeFeeUnsigned(t transaction.AttrType, value int64) (*transaction.Transaction, error) { return c.actor.MakeUnsignedCall(Hash, attributeFeeSetter, nil, byte(t), value) } // BlockAccount creates and sends a transaction that blocks an account on the // network (via `blockAccount` method), it fails (with FAULT state) if it's not // successful. The returned values are transaction hash, its // ValidUntilBlock value and an error if any. func (c *Contract) BlockAccount(account util.Uint160) (util.Uint256, uint32, error) { return c.actor.SendRun(blockScript(account)) } // BlockAccountTransaction creates a transaction that blocks an account on the // network and checks for the result of the appropriate call, failing the // transaction if it's not true. This transaction is signed, but not sent to the // network, instead it's returned to the caller. func (c *Contract) BlockAccountTransaction(account util.Uint160) (*transaction.Transaction, error) { return c.actor.MakeRun(blockScript(account)) } // BlockAccountUnsigned creates a transaction that blocks an account on the // network and checks for the result of the appropriate call, failing the // transaction if it's not true. This transaction is not signed and just returned // to the caller. func (c *Contract) BlockAccountUnsigned(account util.Uint160) (*transaction.Transaction, error) { return c.actor.MakeUnsignedRun(blockScript(account), nil) } func blockScript(account util.Uint160) []byte { // We know parameters exactly (unlike with nep17.Transfer), so this can't fail. script, _ := smartcontract.CreateCallWithAssertScript(Hash, "blockAccount", account) return script } // UnblockAccount creates and sends a transaction that removes previously blocked // account from the stop list. It uses `unblockAccount` method and checks for the // result returned, failing the transaction if it's not true. The returned values // are transaction hash, its ValidUntilBlock value and an error if any. func (c *Contract) UnblockAccount(account util.Uint160) (util.Uint256, uint32, error) { return c.actor.SendRun(unblockScript(account)) } // UnblockAccountTransaction creates a transaction that unblocks previously // blocked account via `unblockAccount` method and checks for the result returned, // failing the transaction if it's not true. This transaction is signed, but not // sent to the network, instead it's returned to the caller. func (c *Contract) UnblockAccountTransaction(account util.Uint160) (*transaction.Transaction, error) { return c.actor.MakeRun(unblockScript(account)) } // UnblockAccountUnsigned creates a transaction that unblocks the given account // if it was blocked previously. It uses `unblockAccount` method and checks for // its return value, failing the transaction if it's not true. This transaction // is not signed and just returned to the caller. func (c *Contract) UnblockAccountUnsigned(account util.Uint160) (*transaction.Transaction, error) { return c.actor.MakeUnsignedRun(unblockScript(account), nil) } func unblockScript(account util.Uint160) []byte { // We know parameters exactly (unlike with nep17.Transfer), so this can't fail. script, _ := smartcontract.CreateCallWithAssertScript(Hash, "unblockAccount", account) return script }