| 123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532533534535536537538539540541542543544545546547548549550551552553554555556557558559560561562563564565566567568569570571572573574575576577578579580581582583584585586587588589590591592593594595596597598599600601602603604605606607608609610611612613614615616617618619620621622623624625626627628629630631632633634635636637638639640641642643644645646647648649650651652653654655656657658659660661662663664665666667668669670671672673674675676677678679680681682683684685686687688689690691692693694695696697698699700701702703704705706707708709710711712713714715716717718719720721722723724725726727728729730731732733734735736737738739740741742743744745746747748749750751752753754755756757758759760761762763764765766767768769770771772773774775776777778779780781782783784785786787788789790791792793794795796797798799800801802803804805806807808809810811812813814815816817818819820821822823824825826827828829830831832833834835836837838839840841842843844845846847848849850851852853854855856857858859860861862863864865866867868869870871872873874875876877878879880881882883884885886887888889890891892893894895896897898899900901902903904905906907908909910911912913914915916917918919920921922923924925926927928929930931932933934935936937938939940941942943944945946947948949950951952953954955956957958959960961962 |
- package ccq
- import (
- "encoding/hex"
- "strings"
- "testing"
- "github.com/certusone/wormhole/node/pkg/common"
- "github.com/certusone/wormhole/node/pkg/query"
- "github.com/stretchr/testify/assert"
- "github.com/stretchr/testify/require"
- "github.com/wormhole-foundation/wormhole/sdk/vaa"
- "go.uber.org/zap"
- "golang.org/x/time/rate"
- )
- func TestParseConfigFileDoesntExist(t *testing.T) {
- _, err := parseConfigFile("missingFile.json", common.MainNet)
- require.Error(t, err)
- assert.Equal(t, `failed to open permissions file "missingFile.json": open missingFile.json: no such file or directory`, err.Error())
- }
- func TestParseConfigBadJson(t *testing.T) {
- str := `
- {
- "permissions": [
- {
- "userName": "Test User",
- "apiKey": "my_secret_key",
- "allowedCalls": [
- {
- "ethCall": {
- "note:": "Name of WETH on Goerli",
- "chain": 2,
- "contractAddress": "B4FBF271143F4FBf7B91A5ded31805e42b2208d6",
- "call": "0x06fdde03"
- }
- }
- ]
- },
- {
- "userName": "Test User",
- "apiKey": "my_secret_key_2",
- "allowUnsigned": true,
- "allowedCalls": [
- {
- "ethCall": {
- "note:": "Name of WETH on Goerli",
- "chain": 2,
- "contractAddress": "0xB4FBF271143F4FBf7B91A5ded31805e42b2208d6",
- "call": "0x06fdde03"
- }
- }
- ]
- }`
- _, err := parseConfig([]byte(str), common.MainNet)
- require.Error(t, err)
- assert.Equal(t, `failed to unmarshal json: unexpected end of JSON input`, err.Error())
- }
- func TestParseConfigDuplicateUser(t *testing.T) {
- str := `
- {
- "permissions": [
- {
- "userName": "Test User",
- "apiKey": "my_secret_key",
- "allowedCalls": [
- {
- "ethCall": {
- "note:": "Name of WETH on Goerli",
- "chain": 2,
- "contractAddress": "B4FBF271143F4FBf7B91A5ded31805e42b2208d6",
- "call": "0x06fdde03"
- }
- }
- ]
- },
- {
- "userName": "Test User",
- "apiKey": "my_secret_key_2",
- "allowUnsigned": true,
- "allowedCalls": [
- {
- "ethCall": {
- "note:": "Name of WETH on Goerli",
- "chain": 2,
- "contractAddress": "0xB4FBF271143F4FBf7B91A5ded31805e42b2208d6",
- "call": "0x06fdde03"
- }
- }
- ]
- }
- ]
- }`
- _, err := parseConfig([]byte(str), common.MainNet)
- require.Error(t, err)
- assert.Equal(t, `UserName "Test User" is a duplicate`, err.Error())
- }
- func TestParseConfigDuplicateApiKey(t *testing.T) {
- str := `
- {
- "permissions": [
- {
- "userName": "Test User 1",
- "apiKey": "my_secret_key",
- "allowedCalls": [
- {
- "ethCall": {
- "note:": "Name of WETH on Goerli",
- "chain": 2,
- "contractAddress": "B4FBF271143F4FBf7B91A5ded31805e42b2208d6",
- "call": "0x06fdde03"
- }
- }
- ]
- },
- {
- "userName": "Test User 2",
- "apiKey": "my_secret_key",
- "allowUnsigned": true,
- "allowedCalls": [
- {
- "ethCall": {
- "note:": "Name of WETH on Goerli",
- "chain": 2,
- "contractAddress": "0xB4FBF271143F4FBf7B91A5ded31805e42b2208d6",
- "call": "0x06fdde03"
- }
- }
- ]
- }
- ]
- }`
- _, err := parseConfig([]byte(str), common.MainNet)
- require.Error(t, err)
- assert.Equal(t, `API key "my_secret_key" is a duplicate`, err.Error())
- }
- func TestParseConfigUnsupportedCallType(t *testing.T) {
- str := `
- {
- "permissions": [
- {
- "userName": "Test User",
- "apiKey": "my_secret_key",
- "allowedCalls": [
- {
- "badCallType": {
- "note:": "Name of WETH on Goerli",
- "chain": 2,
- "contractAddress": "B4FBF271143F4FBf7B91A5ded31805e42b2208d6",
- "call": "0x06fdde03"
- }
- }
- ]
- }
- ]
- }`
- _, err := parseConfig([]byte(str), common.MainNet)
- require.Error(t, err)
- assert.Equal(t, `unsupported call type for user "Test User", must be "ethCall", "ethCallByTimestamp", "ethCallWithFinality", "solAccount" or "solPDA"`, err.Error())
- }
- func TestParseConfigInvalidContractAddress(t *testing.T) {
- str := `
- {
- "permissions": [
- {
- "userName": "Test User",
- "apiKey": "my_secret_key",
- "allowedCalls": [
- {
- "ethCall": {
- "note:": "Name of WETH on Goerli",
- "chain": 2,
- "contractAddress": "HelloWorld",
- "call": "0x06fdde"
- }
- }
- ]
- }
- ]
- }`
- _, err := parseConfig([]byte(str), common.MainNet)
- require.Error(t, err)
- assert.Equal(t, `invalid contract address "HelloWorld" for user "Test User"`, err.Error())
- }
- func TestParseConfigInvalidEthCall(t *testing.T) {
- str := `
- {
- "permissions": [
- {
- "userName": "Test User",
- "apiKey": "my_secret_key",
- "allowedCalls": [
- {
- "ethCall": {
- "note:": "Name of WETH on Goerli",
- "chain": 2,
- "contractAddress": "B4FBF271143F4FBf7B91A5ded31805e42b2208d6",
- "call": "HelloWorld"
- }
- }
- ]
- }
- ]
- }`
- _, err := parseConfig([]byte(str), common.MainNet)
- require.Error(t, err)
- assert.Equal(t, `invalid eth call "HelloWorld" for user "Test User"`, err.Error())
- }
- func TestParseConfigInvalidEthCallLength(t *testing.T) {
- str := `
- {
- "permissions": [
- {
- "userName": "Test User",
- "apiKey": "my_secret_key",
- "allowedCalls": [
- {
- "ethCall": {
- "note:": "Name of WETH on Goerli",
- "chain": 2,
- "contractAddress": "B4FBF271143F4FBf7B91A5ded31805e42b2208d6",
- "call": "0x06fd"
- }
- }
- ]
- }
- ]
- }`
- _, err := parseConfig([]byte(str), common.MainNet)
- require.Error(t, err)
- assert.Equal(t, `eth call "0x06fd" for user "Test User" has an invalid length, must be 4 bytes`, err.Error())
- }
- func TestParseConfigDuplicateAllowedCallForUser(t *testing.T) {
- str := `
- {
- "permissions": [
- {
- "userName": "Test User",
- "apiKey": "my_secret_key",
- "allowedCalls": [
- {
- "ethCall": {
- "note:": "Name of WETH on Goerli",
- "chain": 2,
- "contractAddress": "B4FBF271143F4FBf7B91A5ded31805e42b2208d6",
- "call": "0x06fdde03"
- }
- },
- {
- "ethCall": {
- "note:": "Name of WETH on Goerli",
- "chain": 2,
- "contractAddress": "B4FBF271143F4FBf7B91A5ded31805e42b2208d6",
- "call": "0x06fdde03"
- }
- }
- ]
- }
- ]
- }`
- _, err := parseConfig([]byte(str), common.MainNet)
- require.Error(t, err)
- assert.Equal(t, `"ethCall:2:000000000000000000000000b4fbf271143f4fbf7b91a5ded31805e42b2208d6:06fdde03" is a duplicate allowed call for user "Test User"`, err.Error())
- }
- func TestParseConfigSuccess(t *testing.T) {
- str := `
- {
- "permissions": [
- {
- "userName": "Test User",
- "apiKey": "My_secret_key",
- "allowedCalls": [
- {
- "ethCall": {
- "note:": "Name of WETH on Goerli",
- "chain": 2,
- "contractAddress": "B4FBF271143F4FBf7B91A5ded31805e42b2208d6",
- "call": "0x06fdde03"
- }
- },
- {
- "ethCallByTimestamp": {
- "note:": "Name of WETH on Goerli",
- "chain": 2,
- "contractAddress": "B4FBF271143F4FBf7B91A5ded31805e42b2208d7",
- "call": "0x06fdde03"
- }
- },
- {
- "ethCallWithFinality": {
- "note:": "Decimals of WETH on Devnet",
- "chain": 2,
- "contractAddress": "0xDDb64fE46a91D46ee29420539FC25FD07c5FEa3E",
- "call": "0x313ce567"
- }
- },
- {
- "solAccount": {
- "note:": "Example NFT on Devnet",
- "chain": 1,
- "account": "BVxyYhm498L79r4HMQ9sxZ5bi41DmJmeWZ7SCS7Cyvna"
- }
- },
- {
- "solPDA": {
- "note:": "Core Bridge on Devnet",
- "chain": 1,
- "programAddress": "Bridge1p5gheXUvJ6jGWGeCsgPKgnE3YgdGKRVCMY9o"
- }
- }
- ]
- }
- ]
- }`
- perms, err := parseConfig([]byte(str), common.MainNet)
- require.NoError(t, err)
- assert.Equal(t, 1, len(perms))
- perm, exists := perms["my_secret_key"]
- require.True(t, exists)
- assert.Equal(t, 5, len(perm.allowedCalls))
- _, exists = perm.allowedCalls["ethCall:2:000000000000000000000000b4fbf271143f4fbf7b91a5ded31805e42b2208d6:06fdde03"]
- assert.True(t, exists)
- _, exists = perm.allowedCalls["ethCallByTimestamp:2:000000000000000000000000b4fbf271143f4fbf7b91a5ded31805e42b2208d7:06fdde03"]
- assert.True(t, exists)
- _, exists = perm.allowedCalls["ethCallWithFinality:2:000000000000000000000000ddb64fe46a91d46ee29420539fc25fd07c5fea3e:313ce567"]
- assert.True(t, exists)
- _, exists = perm.allowedCalls["solAccount:1:BVxyYhm498L79r4HMQ9sxZ5bi41DmJmeWZ7SCS7Cyvna"]
- assert.True(t, exists)
- _, exists = perm.allowedCalls["solPDA:1:Bridge1p5gheXUvJ6jGWGeCsgPKgnE3YgdGKRVCMY9o"]
- assert.True(t, exists)
- }
- func TestParseConfigAllowAnythingWhenNotSpecified(t *testing.T) {
- str := `
- {
- "permissions": [
- {
- "userName": "Test User",
- "apiKey": "my_secret_key",
- "allowedCalls": [
- {
- "ethCall": {
- "note:": "Name of WETH on Goerli",
- "chain": 2,
- "contractAddress": "B4FBF271143F4FBf7B91A5ded31805e42b2208d6",
- "call": "0x06fdde03"
- }
- }
- ]
- },
- {
- "userName": "Test User2",
- "apiKey": "my_secret_key_2",
- "allowUnsigned": true,
- "allowAnything": true
- }
- ]
- }`
- _, err := parseConfig([]byte(str), common.TestNet)
- require.Error(t, err)
- assert.Equal(t, `UserName "Test User2" has "allowAnything" specified when the feature is not enabled`, err.Error())
- }
- func TestParseConfigAllowAnythingWhenNotEnabled(t *testing.T) {
- str := `
- {
- "AllowAnythingSupported": false,
- "permissions": [
- {
- "userName": "Test User",
- "apiKey": "my_secret_key",
- "allowedCalls": [
- {
- "ethCall": {
- "note:": "Name of WETH on Goerli",
- "chain": 2,
- "contractAddress": "B4FBF271143F4FBf7B91A5ded31805e42b2208d6",
- "call": "0x06fdde03"
- }
- }
- ]
- },
- {
- "userName": "Test User2",
- "apiKey": "my_secret_key_2",
- "allowUnsigned": true,
- "allowAnything": true
- }
- ]
- }`
- _, err := parseConfig([]byte(str), common.TestNet)
- require.Error(t, err)
- assert.Equal(t, `UserName "Test User2" has "allowAnything" specified when the feature is not enabled`, err.Error())
- }
- func TestParseConfigAllowAnythingWithAllowedCallsIsInvalid(t *testing.T) {
- str := `
- {
- "allowAnythingSupported": true,
- "permissions": [
- {
- "userName": "Test User",
- "apiKey": "my_secret_key",
- "allowedCalls": [
- {
- "ethCall": {
- "note:": "Name of WETH on Goerli",
- "chain": 2,
- "contractAddress": "B4FBF271143F4FBf7B91A5ded31805e42b2208d6",
- "call": "0x06fdde03"
- }
- }
- ]
- },
- {
- "userName": "Test User2",
- "apiKey": "my_secret_key_2",
- "allowUnsigned": true,
- "allowAnything": true,
- "allowedCalls": [
- {
- "ethCall": {
- "note:": "Name of WETH on Goerli",
- "chain": 2,
- "contractAddress": "0xB4FBF271143F4FBf7B91A5ded31805e42b2208d6",
- "call": "0x06fdde03"
- }
- }
- ]
- }
- ]
- }`
- _, err := parseConfig([]byte(str), common.TestNet)
- require.Error(t, err)
- assert.Equal(t, `UserName "Test User2" has "allowedCalls" specified with "allowAnything", which is not allowed`, err.Error())
- }
- func TestParseConfigAllowAnythingNotAllowedInMainnet(t *testing.T) {
- str := `
- {
- "allowAnythingSupported": true,
- "permissions": [
- {
- "userName": "Test User",
- "apiKey": "my_secret_key",
- "allowedCalls": [
- {
- "ethCall": {
- "note:": "Name of WETH on Goerli",
- "chain": 2,
- "contractAddress": "B4FBF271143F4FBf7B91A5ded31805e42b2208d6",
- "call": "0x06fdde03"
- }
- }
- ]
- },
- {
- "userName": "Test User2",
- "apiKey": "my_secret_key_2",
- "allowUnsigned": true,
- "allowAnything": true
- }
- ]
- }`
- _, err := parseConfig([]byte(str), common.MainNet)
- require.Equal(t, `the "allowAnythingSupported" flag is not supported in mainnet`, err.Error())
- }
- func TestParseConfigAllowAnythingSuccess(t *testing.T) {
- str := `
- {
- "allowAnythingSupported": true,
- "permissions": [
- {
- "userName": "Test User",
- "apiKey": "my_secret_key",
- "allowedCalls": [
- {
- "ethCall": {
- "note:": "Name of WETH on Goerli",
- "chain": 2,
- "contractAddress": "B4FBF271143F4FBf7B91A5ded31805e42b2208d6",
- "call": "0x06fdde03"
- }
- }
- ]
- },
- {
- "userName": "Test User2",
- "apiKey": "my_secret_key_2",
- "allowUnsigned": true,
- "allowAnything": true
- }
- ]
- }`
- perms, err := parseConfig([]byte(str), common.TestNet)
- require.NoError(t, err)
- assert.Equal(t, 2, len(perms))
- perm, ok := perms["my_secret_key"]
- require.True(t, ok)
- assert.False(t, perm.allowAnything)
- perm, ok = perms["my_secret_key_2"]
- require.True(t, ok)
- assert.True(t, perm.allowAnything)
- }
- func TestParseConfigContractWildcard(t *testing.T) {
- str := `
- {
- "permissions": [
- {
- "userName": "Test User",
- "apiKey": "my_secret_key",
- "allowedCalls": [
- {
- "ethCall": {
- "note:": "Name of anything on Goerli",
- "chain": 2,
- "contractAddress": "*",
- "call": "0x06fdde03"
- }
- },
- {
- "ethCallByTimestamp": {
- "note:": "Total supply of WETH on Goerli",
- "chain": 2,
- "contractAddress": "0xB4FBF271143F4FBf7B91A5ded31805e42b2208d6",
- "call": "0x18160ddd"
- }
- }
- ]
- }
- ]
- }`
- perms, err := parseConfig([]byte(str), common.MainNet)
- require.NoError(t, err)
- assert.Equal(t, 1, len(perms))
- permsForUser, ok := perms["my_secret_key"]
- require.True(t, ok)
- assert.Equal(t, 2, len(permsForUser.allowedCalls))
- logger := zap.NewNop()
- type testCase struct {
- label string
- callType string
- chainID vaa.ChainID
- contractAddress string
- data string
- errText string // empty string means success
- }
- var testCases = []testCase{
- {
- label: "Wild card, success",
- callType: "ethCall",
- chainID: vaa.ChainIDEthereum,
- contractAddress: "0xB4FBF271143F4FBf7B91A5ded31805e42b2208d6",
- data: "0x06fdde03",
- errText: "",
- },
- {
- label: "Wild card, success, different address",
- callType: "ethCall",
- chainID: vaa.ChainIDEthereum,
- contractAddress: "0xB4FBF271143F4FBf7B91A5ded31805e42b2208d7",
- data: "0x06fdde03",
- errText: "",
- },
- {
- label: "Wild card, wrong call type",
- callType: "ethCallByTimestamp",
- chainID: vaa.ChainIDEthereum,
- contractAddress: "0xB4FBF271143F4FBf7B91A5ded31805e42b2208d6",
- data: "0x06fdde03",
- errText: "not authorized",
- },
- {
- label: "Wild card, wrong chain",
- callType: "ethCall",
- chainID: vaa.ChainIDBase,
- contractAddress: "0xB4FBF271143F4FBf7B91A5ded31805e42b2208d6",
- data: "0x06fdde03",
- errText: "not authorized",
- },
- {
- label: "Specific, success",
- callType: "ethCallByTimestamp",
- chainID: vaa.ChainIDEthereum,
- contractAddress: "0xB4FBF271143F4FBf7B91A5ded31805e42b2208d6",
- data: "0x18160ddd",
- errText: "",
- },
- {
- label: "Specific, wrong call type",
- callType: "ethCall",
- chainID: vaa.ChainIDEthereum,
- contractAddress: "0xB4FBF271143F4FBf7B91A5ded31805e42b2208d6",
- data: "0x18160ddd",
- errText: "not authorized",
- },
- {
- label: "Specific, wrong chain",
- callType: "ethCallByTimestamp",
- chainID: vaa.ChainIDBase,
- contractAddress: "0xB4FBF271143F4FBf7B91A5ded31805e42b2208d6",
- data: "0x18160ddd",
- errText: "not authorized",
- },
- {
- label: "Specific, wrong address",
- callType: "ethCallByTimestamp",
- chainID: vaa.ChainIDEthereum,
- contractAddress: "0xB4FBF271143F4FBf7B91A5ded31805e42b2208d7",
- data: "0x18160ddd",
- errText: "not authorized",
- },
- {
- label: "Specific, wrong data",
- callType: "ethCallByTimestamp",
- chainID: vaa.ChainIDEthereum,
- contractAddress: "0xB4FBF271143F4FBf7B91A5ded31805e42b2208d6",
- data: "0x18160dde",
- errText: "not authorized",
- },
- }
- for _, tst := range testCases {
- t.Run(tst.label, func(t *testing.T) {
- status, err := validateCallData(logger, permsForUser, tst.callType, tst.chainID, createCallData(t, tst.contractAddress, tst.data))
- if tst.errText == "" {
- require.NoError(t, err)
- assert.Equal(t, 200, status)
- } else {
- require.ErrorContains(t, err, tst.errText)
- }
- })
- }
- }
- func createCallData(t *testing.T, toStr string, dataStr string) []*query.EthCallData {
- t.Helper()
- to, err := vaa.StringToAddress(strings.TrimPrefix(toStr, "0x"))
- require.NoError(t, err)
- data, err := hex.DecodeString(strings.TrimPrefix(dataStr, "0x"))
- require.NoError(t, err)
- return []*query.EthCallData{
- {
- To: to.Bytes(),
- Data: data,
- },
- }
- }
- func TestParseConfigWithRateLimiterNoDefaults(t *testing.T) {
- str := `
- {
- "permissions": [
- {
- "userName": "Test user without rate limits",
- "apiKey": "my_secret_key_without_rate_limits",
- "allowedCalls": [
- {
- "ethCall": {
- "note:": "Name of WETH on Goerli",
- "chain": 2,
- "contractAddress": "B4FBF271143F4FBf7B91A5ded31805e42b2208d6",
- "call": "0x06fdde03"
- }
- }
- ]
- },
- {
- "userName": "Test user with rate limits",
- "apiKey": "my_secret_key_with_rate_limits",
- "rateLimit": 0.5,
- "burstSize": 1,
- "allowedCalls": [
- {
- "ethCall": {
- "note:": "Name of WETH on Goerli",
- "chain": 2,
- "contractAddress": "B4FBF271143F4FBf7B91A5ded31805e42b2208d6",
- "call": "0x06fdde03"
- }
- }
- ]
- }
- ]
- }`
- perms, err := parseConfig([]byte(str), common.MainNet)
- require.NoError(t, err)
- assert.Equal(t, 2, len(perms))
- perm, exists := perms["my_secret_key_without_rate_limits"]
- require.True(t, exists)
- assert.Nil(t, perm.rateLimiter)
- perm, exists = perms["my_secret_key_with_rate_limits"]
- require.True(t, exists)
- require.NotNil(t, perm.rateLimiter)
- assert.Equal(t, rate.Limit(0.5), perm.rateLimiter.Limit())
- assert.Equal(t, 1, perm.rateLimiter.Burst())
- }
- func TestParseConfigWithRateLimiterWithDefaults(t *testing.T) {
- str := `
- {
- "defaultRateLimit": 0.5,
- "defaultBurstSize": 1,
- "permissions": [
- {
- "userName": "Test user using default rate limits",
- "apiKey": "my_secret_key_using_default_rate_limits",
- "allowedCalls": [
- {
- "ethCall": {
- "note:": "Name of WETH on Goerli",
- "chain": 2,
- "contractAddress": "B4FBF271143F4FBf7B91A5ded31805e42b2208d6",
- "call": "0x06fdde03"
- }
- }
- ]
- },
- {
- "userName": "Test user overriding default rate limits",
- "apiKey": "my_secret_key_overriding_default_rate_limits",
- "rateLimit": 1,
- "burstSize": 2,
- "allowedCalls": [
- {
- "ethCall": {
- "note:": "Name of WETH on Goerli",
- "chain": 2,
- "contractAddress": "B4FBF271143F4FBf7B91A5ded31805e42b2208d6",
- "call": "0x06fdde03"
- }
- }
- ]
- },
- {
- "userName": "Test user disabling rate limits",
- "apiKey": "my_secret_key_disabling_rate_limits",
- "rateLimit": 0,
- "allowedCalls": [
- {
- "ethCall": {
- "note:": "Name of WETH on Goerli",
- "chain": 2,
- "contractAddress": "B4FBF271143F4FBf7B91A5ded31805e42b2208d6",
- "call": "0x06fdde03"
- }
- }
- ]
- }
- ]
- }`
- perms, err := parseConfig([]byte(str), common.MainNet)
- require.NoError(t, err)
- assert.Equal(t, 3, len(perms))
- perm, exists := perms["my_secret_key_using_default_rate_limits"]
- require.True(t, exists)
- require.NotNil(t, perm.rateLimiter)
- assert.Equal(t, rate.Limit(0.5), perm.rateLimiter.Limit())
- assert.Equal(t, 1, perm.rateLimiter.Burst())
- perm, exists = perms["my_secret_key_overriding_default_rate_limits"]
- require.True(t, exists)
- require.NotNil(t, perm.rateLimiter)
- assert.Equal(t, rate.Limit(1.0), perm.rateLimiter.Limit())
- assert.Equal(t, 2, perm.rateLimiter.Burst())
- perm, exists = perms["my_secret_key_disabling_rate_limits"]
- require.True(t, exists)
- require.Nil(t, perm.rateLimiter)
- }
- func TestParseConfigWithRateLimiterPerUser(t *testing.T) {
- str := `
- {
- "defaultRateLimit": 0.5,
- "defaultBurstSize": 1,
- "permissions": [
- {
- "userName": "Test User",
- "apiKey": "My_secret_key",
- "rateLimit": 1.5,
- "burstSize": 3,
- "allowedCalls": [
- {
- "ethCall": {
- "note:": "Name of WETH on Goerli",
- "chain": 2,
- "contractAddress": "B4FBF271143F4FBf7B91A5ded31805e42b2208d6",
- "call": "0x06fdde03"
- }
- }
- ]
- },
- {
- "userName": "Test User 2",
- "apiKey": "My_secret_key_2",
- "allowedCalls": [
- {
- "ethCall": {
- "note:": "Name of WETH on Goerli",
- "chain": 2,
- "contractAddress": "B4FBF271143F4FBf7B91A5ded31805e42b2208d6",
- "call": "0x06fdde03"
- }
- }
- ]
- }
- ]
- }`
- perms, err := parseConfig([]byte(str), common.MainNet)
- require.NoError(t, err)
- assert.Equal(t, 2, len(perms))
- perm, exists := perms["my_secret_key"]
- require.True(t, exists)
- require.NotNil(t, perm.rateLimiter)
- assert.Equal(t, rate.Limit(1.5), perm.rateLimiter.Limit())
- assert.Equal(t, 3, perm.rateLimiter.Burst())
- perm, exists = perms["my_secret_key_2"]
- require.True(t, exists)
- require.NotNil(t, perm.rateLimiter)
- assert.Equal(t, rate.Limit(0.5), perm.rateLimiter.Limit())
- assert.Equal(t, 1, perm.rateLimiter.Burst())
- }
- func TestParseConfigWithRateLimiterButDefaultBurstSizeNotSet(t *testing.T) {
- str := `
- {
- "defaultRateLimit": 0.5,
- "permissions": [
- {
- "userName": "Test user using default rate limits",
- "apiKey": "my_secret_key_using_default_rate_limits",
- "allowedCalls": [
- {
- "ethCall": {
- "note:": "Name of WETH on Goerli",
- "chain": 2,
- "contractAddress": "B4FBF271143F4FBf7B91A5ded31805e42b2208d6",
- "call": "0x06fdde03"
- }
- }
- ]
- }
- ]
- }`
- perms, err := parseConfig([]byte(str), common.MainNet)
- require.NoError(t, err)
- assert.Equal(t, 1, len(perms))
- perm, exists := perms["my_secret_key_using_default_rate_limits"]
- require.True(t, exists)
- require.NotNil(t, perm.rateLimiter)
- assert.Equal(t, rate.Limit(0.5), perm.rateLimiter.Limit())
- assert.Equal(t, 1, perm.rateLimiter.Burst())
- }
- func TestParseConfigWithRateLimiterButDefaultBurstSizeNIsSetToZero(t *testing.T) {
- str := `
- {
- "defaultBurstSize": 0,
- "permissions": [
- {
- "userName": "Test user using default rate limits",
- "apiKey": "my_secret_key_using_default_rate_limits",
- "allowedCalls": [
- {
- "ethCall": {
- "note:": "Name of WETH on Goerli",
- "chain": 2,
- "contractAddress": "B4FBF271143F4FBf7B91A5ded31805e42b2208d6",
- "call": "0x06fdde03"
- }
- }
- ]
- }
- ]
- }`
- _, err := parseConfig([]byte(str), common.MainNet)
- assert.Equal(t, "the default burst size may not be zero", err.Error())
- }
- func TestParseConfigWithRateLimiterButPerUserBurstSizeSetToZero(t *testing.T) {
- str := `
- {
- "defaultRateLimit": 0.5,
- "defaultBurstSize": 1,
- "permissions": [
- {
- "userName": "Test user overriding default rate limits",
- "apiKey": "my_secret_key_overriding_default_rate_limits",
- "rateLimit": 1,
- "burstSize": 0,
- "allowedCalls": [
- {
- "ethCall": {
- "note:": "Name of WETH on Goerli",
- "chain": 2,
- "contractAddress": "B4FBF271143F4FBf7B91A5ded31805e42b2208d6",
- "call": "0x06fdde03"
- }
- }
- ]
- }
- ]
- }`
- _, err := parseConfig([]byte(str), common.MainNet)
- assert.Equal(t, "if rate limiting is enabled, the burst size may not be zero", err.Error())
- }
|