From c967005216d80cfb0071382f6eced98003afeb3c Mon Sep 17 00:00:00 2001
From: Roman Khimov <roman@nspcc.ru>
Date: Fri, 12 Aug 2022 15:52:16 +0300
Subject: [PATCH] rpcclient: add deprecation notices
And fix test code using old APIs to pass linter checks.
---
pkg/rpcclient/nep17.go | 20 +++++++++++++++++
pkg/services/rpcsrv/client_test.go | 36 +++++++++++++++++++++---------
2 files changed, 46 insertions(+), 10 deletions(-)
diff --git a/pkg/rpcclient/nep17.go b/pkg/rpcclient/nep17.go
index 329f88fca..8e86e3f43 100644
--- a/pkg/rpcclient/nep17.go
+++ b/pkg/rpcclient/nep17.go
@@ -27,21 +27,35 @@ type SignerAccount struct {
}
// NEP17Decimals invokes `decimals` NEP-17 method on the specified contract.
+//
+// Deprecated: please use nep17 package, this method will be removed in future
+// versions.
func (c *Client) NEP17Decimals(tokenHash util.Uint160) (int64, error) {
return c.nepDecimals(tokenHash)
}
// NEP17Symbol invokes `symbol` NEP-17 method on the specified contract.
+//
+// Deprecated: please use nep17 package, this method will be removed in future
+// versions.
func (c *Client) NEP17Symbol(tokenHash util.Uint160) (string, error) {
return c.nepSymbol(tokenHash)
}
// NEP17TotalSupply invokes `totalSupply` NEP-17 method on the specified contract.
+//
+// Deprecated: please use nep17 package, this method will be removed in future
+// versions. This method is also wrong since tokens can return values overflowing
+// int64.
func (c *Client) NEP17TotalSupply(tokenHash util.Uint160) (int64, error) {
return c.nepTotalSupply(tokenHash)
}
// NEP17BalanceOf invokes `balanceOf` NEP-17 method on the specified contract.
+//
+// Deprecated: please use nep17 package, this method will be removed in future
+// versions. This method is also wrong since tokens can return values overflowing
+// int64.
func (c *Client) NEP17BalanceOf(tokenHash, acc util.Uint160) (int64, error) {
return c.nepBalanceOf(tokenHash, acc, nil)
}
@@ -55,6 +69,9 @@ func (c *Client) NEP17TokenInfo(tokenHash util.Uint160) (*wallet.Token, error) {
// method of the given contract (token) to move the specified amount of NEP-17 assets
// (in FixedN format using contract's number of decimals) to the given account and
// returns it. The returned transaction is not signed.
+//
+// Deprecated: please use nep17 package, this method will be removed in future
+// versions.
func (c *Client) CreateNEP17TransferTx(acc *wallet.Account, to util.Uint160,
token util.Uint160, amount int64, gas int64, data interface{}, cosigners []SignerAccount) (*transaction.Transaction, error) {
return c.CreateNEP17MultiTransferTx(acc, gas, []TransferTarget{
@@ -140,6 +157,9 @@ func (c *Client) CreateTxFromScript(script []byte, acc *wallet.Account, sysFee,
// specifies a set of the transaction cosigners (may be nil or may include sender)
// with a proper scope and the accounts to cosign the transaction. If cosigning is
// impossible (e.g. due to locked cosigner's account) an error is returned.
+//
+// Deprecated: please use nep17 package, this method will be removed in future
+// versions.
func (c *Client) TransferNEP17(acc *wallet.Account, to util.Uint160, token util.Uint160,
amount int64, gas int64, data interface{}, cosigners []SignerAccount) (util.Uint256, error) {
tx, err := c.CreateNEP17TransferTx(acc, to, token, amount, gas, data, cosigners)
diff --git a/pkg/services/rpcsrv/client_test.go b/pkg/services/rpcsrv/client_test.go
index 354bf38d8..ef11a0f7b 100644
--- a/pkg/services/rpcsrv/client_test.go
+++ b/pkg/services/rpcsrv/client_test.go
@@ -29,6 +29,9 @@ import (
"github.com/nspcc-dev/neo-go/pkg/neorpc/result"
"github.com/nspcc-dev/neo-go/pkg/network"
"github.com/nspcc-dev/neo-go/pkg/rpcclient"
+ "github.com/nspcc-dev/neo-go/pkg/rpcclient/actor"
+ "github.com/nspcc-dev/neo-go/pkg/rpcclient/invoker"
+ "github.com/nspcc-dev/neo-go/pkg/rpcclient/nep17"
"github.com/nspcc-dev/neo-go/pkg/rpcclient/nns"
"github.com/nspcc-dev/neo-go/pkg/smartcontract"
"github.com/nspcc-dev/neo-go/pkg/smartcontract/callflag"
@@ -54,19 +57,20 @@ func TestClient_NEP17(t *testing.T) {
h, err := util.Uint160DecodeStringLE(testContractHash)
require.NoError(t, err)
+ rub := nep17.NewReader(invoker.New(c, nil), h)
t.Run("Decimals", func(t *testing.T) {
- d, err := c.NEP17Decimals(h)
+ d, err := rub.Decimals()
require.NoError(t, err)
require.EqualValues(t, 2, d)
})
t.Run("TotalSupply", func(t *testing.T) {
- s, err := c.NEP17TotalSupply(h)
+ s, err := rub.TotalSupply()
require.NoError(t, err)
- require.EqualValues(t, 1_000_000, s)
+ require.EqualValues(t, big.NewInt(1_000_000), s)
})
t.Run("Symbol", func(t *testing.T) {
- sym, err := c.NEP17Symbol(h)
+ sym, err := rub.Symbol()
require.NoError(t, err)
require.Equal(t, "RUB", sym)
})
@@ -80,9 +84,9 @@ func TestClient_NEP17(t *testing.T) {
})
t.Run("BalanceOf", func(t *testing.T) {
acc := testchain.PrivateKeyByID(0).GetScriptHash()
- b, err := c.NEP17BalanceOf(h, acc)
+ b, err := rub.BalanceOf(acc)
require.NoError(t, err)
- require.EqualValues(t, 877, b)
+ require.EqualValues(t, big.NewInt(877), b)
})
}
@@ -721,12 +725,16 @@ func TestCreateNEP17TransferTx(t *testing.T) {
priv := testchain.PrivateKeyByID(0)
acc := wallet.NewAccountFromPrivateKey(priv)
+ addr := priv.PublicKey().GetScriptHash()
gasContractHash, err := c.GetNativeContractHash(nativenames.Gas)
require.NoError(t, err)
t.Run("default scope", func(t *testing.T) {
- tx, err := c.CreateNEP17TransferTx(acc, util.Uint160{}, gasContractHash, 1000, 0, nil, nil)
+ act, err := actor.NewSimple(c, acc)
+ require.NoError(t, err)
+ gas := nep17.New(act, gasContractHash)
+ tx, err := gas.TransferUnsigned(addr, util.Uint160{}, big.NewInt(1000), nil)
require.NoError(t, err)
require.NoError(t, acc.SignTx(testchain.Network(), tx))
require.NoError(t, chain.VerifyTx(tx))
@@ -735,23 +743,31 @@ func TestCreateNEP17TransferTx(t *testing.T) {
require.NoError(t, ic.VM.Run())
})
t.Run("none scope", func(t *testing.T) {
- _, err := c.CreateNEP17TransferTx(acc, util.Uint160{}, gasContractHash, 1000, 0, nil, []rpcclient.SignerAccount{{
+ act, err := actor.New(c, []actor.SignerAccount{{
Signer: transaction.Signer{
- Account: priv.PublicKey().GetScriptHash(),
+ Account: addr,
Scopes: transaction.None,
},
+ Account: acc,
}})
+ require.NoError(t, err)
+ gas := nep17.New(act, gasContractHash)
+ _, err = gas.TransferUnsigned(addr, util.Uint160{}, big.NewInt(1000), nil)
require.Error(t, err)
})
t.Run("customcontracts scope", func(t *testing.T) {
- tx, err := c.CreateNEP17TransferTx(acc, util.Uint160{}, gasContractHash, 1000, 0, nil, []rpcclient.SignerAccount{{
+ act, err := actor.New(c, []actor.SignerAccount{{
Signer: transaction.Signer{
Account: priv.PublicKey().GetScriptHash(),
Scopes: transaction.CustomContracts,
AllowedContracts: []util.Uint160{gasContractHash},
},
+ Account: acc,
}})
require.NoError(t, err)
+ gas := nep17.New(act, gasContractHash)
+ tx, err := gas.TransferUnsigned(addr, util.Uint160{}, big.NewInt(1000), nil)
+ require.NoError(t, err)
require.NoError(t, acc.SignTx(testchain.Network(), tx))
require.NoError(t, chain.VerifyTx(tx))
ic := chain.GetTestVM(trigger.Application, tx, nil)