RateLimit.md

Transaction access rate limit

Datastore setting

For setting datastore to store transaction history, you have to set datastore environment variables.

# In case of redis
DATASTORE=redis
REDIS_URI=<REDIS_URI> # e.g. redis://localhost:6379/0

Rate limit setting

Using txAllowList at src/config/transactionAllowList.ts, you can set transaction rate limit.

const rateLimitA = {
  name: 'wildcard',
  interval: 86400,
  limit: 1000,
};

export const getTxAllowList = (): Array<TransactionAllow> => {
  return [
    {
      fromList: ['*'],
      toList: ['*'],
      rateLimit: rateLimitA,
    },
  ];
};

RateLimit key	Description	Required
name	RateLimit setting name. Must be unique.	O
perFrom	Whether the setting is restricted for each from set in fromList or not
perTo	Whether the setting is restricted for each to set in the toList or not
perMethod	Whether the setting is restricted for each contract method or not
interval	Rate limit interval(seconds)	O
limit	Number of tx's allowed in the interval	O

Please define rateLimit variable and set txAllowList. because rateLimit can be shared by another txAllowList setting.

const rateLimitA = {
  name: 'wildcard',
  perFrom: true,
  perTo: true,
  interval: 86400,
  limit: 1,
};

export const getTxAllowList = (): Array<TransactionAllow> => {
  return [
    {
      fromList: ['*'],
      toList: ['0x9809d9d94b0b3380db38b1e1a06047a2964e0041'],
      rateLimit: rateLimitA,
    },
    {
      fromList: ['*'],
      toList: ['0x40bde52e6b80ae11f34c58c14e1e7fe1f9c834c4'],
      rateLimit: rateLimitA,
    },
  ];
};

Example(limit settings per user)

Each user can perform a transaction to 0x9809d9d94b0b3380db38b1e1a06047a2964e0041 once every 60 seconds.

const rateLimitA = {
  name: 'wildcard',
  perFrom: true,
  interval: 60,
  limit: 1,
};

export const getTxAllowList = (): Array<TransactionAllow> => {
  return [
    {
      fromList: ['*'],
      toList: ['0x9809d9d94b0b3380db38b1e1a06047a2964e0041'],
      rateLimit: rateLimitA,
    },
  ];
};

Example(limit settings per all users)

Transaction to 0x9809d9d94b0b3380db38b1e1a06047a2964e0041 can only be executed once every 60 seconds

const rateLimitA = {
  name: 'wildcard',
  interval: 60,
  limit: 1,
};

export const getTxAllowList = (): Array<TransactionAllow> => {
  return [
    {
      fromList: ['*'],
      toList: ['0x9809d9d94b0b3380db38b1e1a06047a2964e0041'],
      rateLimit: rateLimitA,
    },
  ];
};

Example(limit settings per contract)

Transaction to 0x9809d9d94b0b3380db38b1e1a06047a2964e0041 or 0x40bde52e6b80ae11f34c58c14e1e7fe1f9c834c4 can only be executed once every 60 seconds respectively.

const rateLimitA = {
  name: 'wildcard',
  perTo: true,
  interval: 60,
  limit: 1,
};

export const getTxAllowList = (): Array<TransactionAllow> => {
  return [
    {
      fromList: ['*'],
      toList: ['0x9809d9d94b0b3380db38b1e1a06047a2964e0041'],
      rateLimit: rateLimitA,
    },
    {
      fromList: ['*'],
      toList: ['0x40bde52e6b80ae11f34c58c14e1e7fe1f9c834c4'],
      rateLimit: rateLimitA,
    },
  ];
};

Example(limit settings per all contracts)

Both together, Transaction to 0x9809d9d94b0b3380db38b1e1a06047a2964e0041 or 0x40bde52e6b80ae11f34c58c14e1e7fe1f9c834c4 can only be executed once every 60 seconds.

const rateLimitA = {
  name: 'wildcard',
  interval: 60,
  limit: 1,
};

export const getTxAllowList = (): Array<TransactionAllow> => {
  return [
    {
      fromList: ['*'],
      toList: ['0x9809d9d94b0b3380db38b1e1a06047a2964e0041'],
      rateLimit: rateLimitA,
    },
    {
      fromList: ['*'],
      toList: ['0x40bde52e6b80ae11f34c58c14e1e7fe1f9c834c4'],
      rateLimit: rateLimitA,
    },
  ];
};

Set Addresses unlimited tx rate

Addresses set in getDeployAllowList and getUnlimitedTxRateAddresses are not rate-limited for transactions.

// 0xaf395754eB6F542742784cE7702940C60465A46c and 0xaf395754eB6F542742784cE7702940C60465A46a are not rate-limited for transactions.
export const getDeployAllowList = (): Array<string> => {
  return ['0xaf395754eB6F542742784cE7702940C60465A46c'];
};
export const getUnlimitedTxRateAddresses = (): Array<string> => {
  return ['0xaf395754eB6F542742784cE7702940C60465A46a'];
};

You can set wildcard and exception_pattern

// wild card
// Everyone are not rate-limited for transactions.
export const getDeployAllowList = (): Array<string> => {
  return [''];
};
export const getUnlimitedTxRateAddresses = (): Array<string> => {
  return ['*'];
};

// exception_pattern
// anyone cannot deploy contract.
// any address other than 0xaf395754eB6F542742784cE7702940C60465A46c are not rate-limited for transactions.
export const getDeployAllowList = (): Array<string> => {
  return [''];
};
export const getUnlimitedTxRateAddresses = (): Array<string> => {
  return ['!0xaf395754eB6F542742784cE7702940C60465A46c'];
};