change default gas value to 1_000_000 & update interface

ERC725Alliance · Nov 2, 2023 · ca39593 · ca39593
1 parent 0d0f725
commit ca39593
Show file tree

Hide file tree

Showing 6 changed files with 9 additions and 7 deletions.
diff --git a/docs/classes/ERC725.md b/docs/classes/ERC725.md
@@ -1446,7 +1446,7 @@ On non instantiated class, you should provide an `options` object.
 | :-------- | :----- | :------------------------------------------------------------------- |
 | `address` | string | Address of the smart contract to check against a certain interface.  |
 | `rpcUrl`  | string | RPC URL to connect to the network the smart contract is deployed to. |
-| `gas`     | number | Optional: gas parameter to use. Default: 2_000_000.                  |
+| `gas`     | number | Optional: gas parameter to use. Default: 1_000_000.                  |
 
 #### Returns
 

diff --git a/docs/getting-started.md b/docs/getting-started.md
@@ -61,7 +61,7 @@ const address = '0x0Dc07C77985fE31996Ed612F568eb441afe5768D';
 const RPC_URL = 'https://rpc.testnet.lukso.network';
 const config = {
   ipfsGateway: 'https://YOUR-IPFS-GATEWAY/ipfs/',
-  gas: 20_000_000, // optional, default is 2_000_000
+  gas: 20_000_000, // optional, default is 1_000_000
 };
 
 const erc725 = new ERC725(schemas, address, RPC_URL, config);

diff --git a/src/constants/constants.ts b/src/constants/constants.ts
@@ -172,4 +172,4 @@ export const LSP6_ALL_PERMISSIONS =
 
 export const COMPACT_BYTES_ARRAY_STRING = '[CompactBytesArray]';
 
-export const DEFAULT_GAS_VALUE = 2_000_000;
+export const DEFAULT_GAS_VALUE = 1_000_000;
diff --git a/src/index.ts b/src/index.ts
@@ -81,7 +81,7 @@ export { encodeData } from './lib/utils';
  *
  */
 export class ERC725 {
-  options: ERC725Options & ERC725Config;
+  options: ERC725Options;
 
   /**
    * Creates an instance of ERC725.

diff --git a/src/provider/providerWrapper.test.ts b/src/provider/providerWrapper.test.ts
@@ -3,7 +3,7 @@ import assert from 'assert';
 import { ProviderWrapper } from './providerWrapper';
 
 const erc725AccountAddress = '0x214be121bB52e6909c5158579b3458f8760f1b2f';
-const defaultGas = 2_000_000;
+const defaultGas = 1_000_000;
 
 describe('ProviderWrapper', () => {
   describe('#getOwner', () => {

diff --git a/src/types/Config.ts b/src/types/Config.ts
@@ -5,18 +5,20 @@ export interface ERC725Config {
    * ```js title=Example
    * const config = {
    *   ipfsGateway: 'https://ipfs.lukso.network/ipfs/'
-   *   gas: 20_000_000 // Optional, default 2_000_000
+   *   gas: 20_000_000 // Optional, default 0
    * };
    * ```
    * Make sure to use the following format: `<url>/ipfs/`.<br/>
    * Another example: `https://cloudflare-ipfs.com/ipfs/`
    */
-  ipfsGateway: string;
+  ipfsGateway?: string;
   gas?: number;
 }
 
 export interface ERC725Options {
   schemas: ERC725JSONSchema[];
   address?: string;
   provider?;
+  ipfsGateway: string;
+  gas: number;
 }