Merge pull request #3 from flare-foundation/feat/rename-interfaces-directory

Update contract artifacts to version 0.1.22

Author: fassko

README.md

@@ -1,24 +1,102 @@
-# Flare smart contracts periphery
+# Flare Smart Contracts Periphery
 
-This package contains ABIs, typechain artifacts and addresses for smart contracts on Flare networks Flare, Songbird,
-Coston and Coston2.
+This package contains ABIs and addresses for smart contracts deployed on [Flare networks](https://dev.flare.network/network/solidity-reference):
 
-Enjoy
+- Flare Mainnet
+- Songbird Canary Network
+- Songbird Testnet Coston
+- Flare Testnet Coston2
 
+## Installation
+
+```bash
+npm install @flarenetwork/flare-periphery-contract
+# or
+yarn add @flarenetwork/flare-periphery-contract
+```
 
 ## Features
-This library exposes the following names at top level:
- * `nameToAbi(name:string, network: string): any` and `interfaceToAbi(name: string, network: string): any` - 
- return abi an array of objects.
-    Name is the name of contract/interface and network can be one of coston, coston2, songbird and flare. 
- * `nameToAddress(name: string, provider: ethers.JsonRpcApiProvider): Promise<string>` and `namesToAddresses(names: string[], provider: ethers.JsonRpcApiProvider): Promise<string[]>`.
-  Provider is used to get contract address(es). They are read from FlareContractRegistryLibrary on chain.
- * `FlareContractRegistryAddress` - hardcoded address constant, the same for all chains and should never change.
- * `coston`, `coston2`, `flare` and `songbird` - namespaces with 4 exports:
-    - `products` - an object exposing contracts through `.ContractName` syntax. They have fields
-    `name`, `interface` - interface's name and `abi`, and method `getAddress(provider: JsonRpcProvider): Promise<string>`.
-    - `interfaceAbis` - a class allowing access to abis using `.InterfaceName` syntax. Interface names are
-    usually contract names prefixed with capital letter `I`.
-    - `nameToAbi(name: string): any` and `interfaceToAbi(name: string): any` - the same as top level functions, with omitted network argument
-
-Additionally typechain artifacts are stored in `artifacts/contracts` folders for every chain.
+
+### Top Level Exports
+
+#### ABI Access Functions
+
+- `nameToAbi(name: string, network: string): any`
+- `interfaceToAbi(name: string, network: string): any`
+
+Both functions return an ABI array. The `network` parameter must be one of: 
+
+- `"coston"`
+- `"coston2"`
+- `"songbird"`
+- `"flare"`
+
+```typescript
+import { nameToAbi } from "@flarenetwork/flare-periphery-contract";
+
+const abi = nameToAbi("FtsoManager", "flare");
+```
+
+#### Address Resolution
+
+- `nameToAddress(name: string, provider: ethers.JsonRpcApiProvider): Promise<string>`
+- `namesToAddresses(names: string[], provider: ethers.JsonRpcApiProvider): Promise<string[]>`
+
+These functions fetch contract addresses from the on-chain FlareContractRegistryLibrary.
+
+```typescript
+import { nameToAddress } from "@flarenetwork/flare-periphery-contract";
+import { ethers } from "ethers";
+
+const provider = new ethers.JsonRpcProvider("https://flare-api.flare.network/ext/C/rpc");
+const address = await nameToAddress("FtsoManager", provider);
+```
+
+#### Constants
+
+- `FlareContractRegistryAddress`: Hardcoded registry address (same for all chains)
+
+### Network-Specific Namespaces
+
+Each network (`coston`, `coston2`, `flare`, `songbird`) exports:
+
+#### 1. Products
+
+Access contract information through `.ContractName` syntax:
+
+```typescript
+import { flare } from "@flarenetwork/flare-periphery-contract";
+
+const ftsoManager = flare.products.FtsoManager;
+console.log(ftsoManager.name);        // Contract name
+console.log(ftsoManager.interface);   // Interface name
+console.log(ftsoManager.abi);         // Contract ABI
+
+// Get deployed address
+const address = await ftsoManager.getAddress(provider);
+```
+
+#### 2. Interface ABIs
+
+Access interface ABIs using `.InterfaceName` syntax:
+
+```typescript
+import { flare } from "@flarenetwork/flare-periphery-contract";
+
+const abi = flare.interfaceAbis.IFtsoManager;
+```
+
+#### 3. Network-Specific ABI Functions
+
+It is same as top-level functions but with the pre-set network:
+
+```typescript
+import { flare } from "@flarenetwork/flare-periphery-contract";
+
+const abi = flare.nameToAbi("FtsoManager");      // Network already known
+const iAbi = flare.interfaceToAbi("IFtsoManager");
+```
+
+## Support
+
+For issues and feature requests, please visit our [GitHub repository](https://github.com/flare-foundation/flare-smart-contracts-periphery).

coston/abis.ts

@@ -32,52 +32,52 @@ import IFdcVerification from "./artifacts/contracts/IFdcVerification.sol/IFdcVer
 import IFeeCalculator from "./artifacts/contracts/IFeeCalculator.sol/IFeeCalculator.json";
 import IFlareAssetRegistry from "./artifacts/contracts/IFlareAssetRegistry.sol/IFlareAssetRegistry.json";
 import IFlareContractRegistry from "./artifacts/contracts/IFlareContractRegistry.sol/IFlareContractRegistry.json";
-import IFlareDaemonize from "./artifacts/contracts/genesis/interface/IFlareDaemonize.sol/IFlareDaemonize.json";
+import IFlareDaemonize from "./artifacts/contracts/genesis/interfaces/IFlareDaemonize.sol/IFlareDaemonize.json";
 import IFlareSystemsCalculator from "./artifacts/contracts/IFlareSystemsCalculator.sol/IFlareSystemsCalculator.json";
 import IFlareSystemsManager from "./artifacts/contracts/IFlareSystemsManager.sol/IFlareSystemsManager.json";
 import IFtso from "./artifacts/contracts/IFtso.sol/IFtso.json";
 import IFtsoFeedDecimals from "./artifacts/contracts/IFtsoFeedDecimals.sol/IFtsoFeedDecimals.json";
 import IFtsoFeedIdConverter from "./artifacts/contracts/IFtsoFeedIdConverter.sol/IFtsoFeedIdConverter.json";
 import IFtsoFeedPublisher from "./artifacts/contracts/IFtsoFeedPublisher.sol/IFtsoFeedPublisher.json";
-import IFtsoGenesis from "./artifacts/contracts/genesis/interface/IFtsoGenesis.sol/IFtsoGenesis.json";
+import IFtsoGenesis from "./artifacts/contracts/genesis/interfaces/IFtsoGenesis.sol/IFtsoGenesis.json";
 import IFtsoInflationConfigurations from "./artifacts/contracts/IFtsoInflationConfigurations.sol/IFtsoInflationConfigurations.json";
 import IFtsoManager from "./artifacts/contracts/IFtsoManager.sol/IFtsoManager.json";
-import IFtsoManagerGenesis from "./artifacts/contracts/genesis/interface/IFtsoManagerGenesis.sol/IFtsoManagerGenesis.json";
+import IFtsoManagerGenesis from "./artifacts/contracts/genesis/interfaces/IFtsoManagerGenesis.sol/IFtsoManagerGenesis.json";
 import IFtsoRegistry from "./artifacts/contracts/IFtsoRegistry.sol/IFtsoRegistry.json";
-import IFtsoRegistryGenesis from "./artifacts/contracts/genesis/interface/IFtsoRegistryGenesis.sol/IFtsoRegistryGenesis.json";
+import IFtsoRegistryGenesis from "./artifacts/contracts/genesis/interfaces/IFtsoRegistryGenesis.sol/IFtsoRegistryGenesis.json";
 import IFtsoRewardManager from "./artifacts/contracts/IFtsoRewardManager.sol/IFtsoRewardManager.json";
 import IFtsoRewardOffersManager from "./artifacts/contracts/IFtsoRewardOffersManager.sol/IFtsoRewardOffersManager.json";
 import IGenericRewardManager from "./artifacts/contracts/IGenericRewardManager.sol/IGenericRewardManager.json";
 import IGovernanceSettings from "./artifacts/contracts/IGovernanceSettings.sol/IGovernanceSettings.json";
 import IGovernanceVotePower from "./artifacts/contracts/IGovernanceVotePower.sol/IGovernanceVotePower.json";
 import IGovernor from "./artifacts/contracts/IGovernor.sol/IGovernor.json";
-import IIClaimSetupManager from "./artifacts/contracts/protocol/interface/IIClaimSetupManager.sol/IIClaimSetupManager.json";
-import IICleanable from "./artifacts/contracts/token/interface/IICleanable.sol/IICleanable.json";
-import IICleanupBlockNumberManager from "./artifacts/contracts/protocol/interface/IICleanupBlockNumberManager.sol/IICleanupBlockNumberManager.json";
-import IICustomFeed from "./artifacts/contracts/customFeeds/interface/IICustomFeed.sol/IICustomFeed.json";
-import IIEntityManager from "./artifacts/contracts/protocol/interface/IIEntityManager.sol/IIEntityManager.json";
-import IIFastUpdaterView from "./artifacts/contracts/fscV1/interface/IIFastUpdaterView.sol/IIFastUpdaterView.json";
-import IIFlareSystemsCalculator from "./artifacts/contracts/protocol/interface/IIFlareSystemsCalculator.sol/IIFlareSystemsCalculator.json";
-import IIFlareSystemsManager from "./artifacts/contracts/protocol/interface/IIFlareSystemsManager.sol/IIFlareSystemsManager.json";
-import IIFtso from "./artifacts/contracts/ftso/interface/IIFtso.sol/IIFtso.json";
-import IIFtsoFeedPublisher from "./artifacts/contracts/ftso/interface/IIFtsoFeedPublisher.sol/IIFtsoFeedPublisher.json";
-import IIFtsoManagerProxy from "./artifacts/contracts/fscV1/interface/IIFtsoManagerProxy.sol/IIFtsoManagerProxy.json";
-import IIGovernanceVotePower from "./artifacts/contracts/token/interface/IIGovernanceVotePower.sol/IIGovernanceVotePower.json";
-import IIGovernorProposer from "./artifacts/contracts/governance/interface/IIGovernorProposer.sol/IIGovernorProposer.json";
-import IINodePossessionVerifier from "./artifacts/contracts/protocol/interface/IINodePossessionVerifier.sol/IINodePossessionVerifier.json";
-import IIPollingFoundation from "./artifacts/contracts/governance/interface/IIPollingFoundation.sol/IIPollingFoundation.json";
-import IIPollingManagementGroup from "./artifacts/contracts/governance/interface/IIPollingManagementGroup.sol/IIPollingManagementGroup.json";
-import IIPublicKeyVerifier from "./artifacts/contracts/protocol/interface/IIPublicKeyVerifier.sol/IIPublicKeyVerifier.json";
-import IIRNat from "./artifacts/contracts/rNat/interface/IIRNat.sol/IIRNat.json";
-import IIRNatAccount from "./artifacts/contracts/rNat/interface/IIRNatAccount.sol/IIRNatAccount.json";
-import IIRelay from "./artifacts/contracts/protocol/interface/IIRelay.sol/IIRelay.json";
-import IIRewardEpochSwitchoverTrigger from "./artifacts/contracts/protocol/interface/IIRewardEpochSwitchoverTrigger.sol/IIRewardEpochSwitchoverTrigger.json";
-import IIRewardManager from "./artifacts/contracts/protocol/interface/IIRewardManager.sol/IIRewardManager.json";
-import IISubmission from "./artifacts/contracts/protocol/interface/IISubmission.sol/IISubmission.json";
-import IIVPContract from "./artifacts/contracts/token/interface/IIVPContract.sol/IIVPContract.json";
-import IIVPToken from "./artifacts/contracts/token/interface/IIVPToken.sol/IIVPToken.json";
-import IIVoterRegistrationTrigger from "./artifacts/contracts/protocol/interface/IIVoterRegistrationTrigger.sol/IIVoterRegistrationTrigger.json";
-import IIVoterRegistry from "./artifacts/contracts/protocol/interface/IIVoterRegistry.sol/IIVoterRegistry.json";
+import IIClaimSetupManager from "./artifacts/contracts/protocol/interfaces/IIClaimSetupManager.sol/IIClaimSetupManager.json";
+import IICleanable from "./artifacts/contracts/token/interfaces/IICleanable.sol/IICleanable.json";
+import IICleanupBlockNumberManager from "./artifacts/contracts/protocol/interfaces/IICleanupBlockNumberManager.sol/IICleanupBlockNumberManager.json";
+import IICustomFeed from "./artifacts/contracts/customFeeds/interfaces/IICustomFeed.sol/IICustomFeed.json";
+import IIEntityManager from "./artifacts/contracts/protocol/interfaces/IIEntityManager.sol/IIEntityManager.json";
+import IIFastUpdaterView from "./artifacts/contracts/fscV1/interfaces/IIFastUpdaterView.sol/IIFastUpdaterView.json";
+import IIFlareSystemsCalculator from "./artifacts/contracts/protocol/interfaces/IIFlareSystemsCalculator.sol/IIFlareSystemsCalculator.json";
+import IIFlareSystemsManager from "./artifacts/contracts/protocol/interfaces/IIFlareSystemsManager.sol/IIFlareSystemsManager.json";
+import IIFtso from "./artifacts/contracts/ftso/interfaces/IIFtso.sol/IIFtso.json";
+import IIFtsoFeedPublisher from "./artifacts/contracts/ftso/interfaces/IIFtsoFeedPublisher.sol/IIFtsoFeedPublisher.json";
+import IIFtsoManagerProxy from "./artifacts/contracts/fscV1/interfaces/IIFtsoManagerProxy.sol/IIFtsoManagerProxy.json";
+import IIGovernanceVotePower from "./artifacts/contracts/token/interfaces/IIGovernanceVotePower.sol/IIGovernanceVotePower.json";
+import IIGovernorProposer from "./artifacts/contracts/governance/interfaces/IIGovernorProposer.sol/IIGovernorProposer.json";
+import IINodePossessionVerifier from "./artifacts/contracts/protocol/interfaces/IINodePossessionVerifier.sol/IINodePossessionVerifier.json";
+import IIPollingFoundation from "./artifacts/contracts/governance/interfaces/IIPollingFoundation.sol/IIPollingFoundation.json";
+import IIPollingManagementGroup from "./artifacts/contracts/governance/interfaces/IIPollingManagementGroup.sol/IIPollingManagementGroup.json";
+import IIPublicKeyVerifier from "./artifacts/contracts/protocol/interfaces/IIPublicKeyVerifier.sol/IIPublicKeyVerifier.json";
+import IIRNat from "./artifacts/contracts/rNat/interfaces/IIRNat.sol/IIRNat.json";
+import IIRNatAccount from "./artifacts/contracts/rNat/interfaces/IIRNatAccount.sol/IIRNatAccount.json";
+import IIRelay from "./artifacts/contracts/protocol/interfaces/IIRelay.sol/IIRelay.json";
+import IIRewardEpochSwitchoverTrigger from "./artifacts/contracts/protocol/interfaces/IIRewardEpochSwitchoverTrigger.sol/IIRewardEpochSwitchoverTrigger.json";
+import IIRewardManager from "./artifacts/contracts/protocol/interfaces/IIRewardManager.sol/IIRewardManager.json";
+import IISubmission from "./artifacts/contracts/protocol/interfaces/IISubmission.sol/IISubmission.json";
+import IIVPContract from "./artifacts/contracts/token/interfaces/IIVPContract.sol/IIVPContract.json";
+import IIVPToken from "./artifacts/contracts/token/interfaces/IIVPToken.sol/IIVPToken.json";
+import IIVoterRegistrationTrigger from "./artifacts/contracts/protocol/interfaces/IIVoterRegistrationTrigger.sol/IIVoterRegistrationTrigger.json";
+import IIVoterRegistry from "./artifacts/contracts/protocol/interfaces/IIVoterRegistry.sol/IIVoterRegistry.json";
 import IIncreaseManager from "./artifacts/contracts/IIncreaseManager.sol/IIncreaseManager.json";
 import IPayment from "./artifacts/contracts/IPayment.sol/IPayment.json";
 import IPaymentVerification from "./artifacts/contracts/IPaymentVerification.sol/IPaymentVerification.json";
@@ -93,8 +93,8 @@ import IRelay from "./artifacts/contracts/IRelay.sol/IRelay.json";
 import IRewardManager from "./artifacts/contracts/IRewardManager.sol/IRewardManager.json";
 import ISubmission from "./artifacts/contracts/ISubmission.sol/ISubmission.json";
 import ITransferFees from "./artifacts/contracts/ITransferFees.sol/ITransferFees.json";
-import ITypeTemplate from "./artifacts/contracts/fdc/interface/ITypeTemplate.sol/ITypeTemplate.json";
-import ITypeTemplateVerification from "./artifacts/contracts/fdc/interface/ITypeTemplateVerification.sol/ITypeTemplateVerification.json";
+import ITypeTemplate from "./artifacts/contracts/fdc/interfaces/ITypeTemplate.sol/ITypeTemplate.json";
+import ITypeTemplateVerification from "./artifacts/contracts/fdc/interfaces/ITypeTemplateVerification.sol/ITypeTemplateVerification.json";
 import IVPContractEvents from "./artifacts/contracts/IVPContractEvents.sol/IVPContractEvents.json";
 import IVPToken from "./artifacts/contracts/IVPToken.sol/IVPToken.json";
 import IValidatorRewardOffersManager from "./artifacts/contracts/IValidatorRewardOffersManager.sol/IValidatorRewardOffersManager.json";