Skip to content

Latest commit

 

History

History
287 lines (177 loc) · 8.81 KB

README.md

File metadata and controls

287 lines (177 loc) · 8.81 KB

Contract metaallocator

Management system to provide simpler allowance transfer between RKH, notaries, and clients

Official deployments

Filecoin mainnet:

  • BeaconProxyFactory for client smart contract instances: f410fucmf6dt2uc4trxaljddf4ufduofpilpeyum7cfa

Getting started

Install foundry

Foundry documentation.

Install deps

$ forge install

Build contracts

$ forge build

Run tests

$ forge clean && forge test --ffi -vv

Deploy manually to Filecoin

> forge create --rpc-url <your_rpc_url>  --private-key <your_private_key> src/Allocator.sol:Allocator

[⠊] Compiling...
[⠢] Compiling 80 files with 0.8.25
[⠆] Solc 0.8.25 finished in 11.11s
Compiler run successful!
Deployer: 0xE2328a0A7393914b2f8C4751b709Aa39fE9b7C2f
Deployed to: 0x92C57F4085c76BA9a3D1E28540e5b1ba1Bc9175D
Transaction hash: 0xad23ddbe533922692c379d4aeee66af839939993005ff40c57d6b9363e41d610

implementation_address - address of the Allocator contract(deployed to) from command above

> forge create --rpc-url <your_rpc_url>  --private-key <your_private_key> src/Factory.sol:Factory --constructor-args "<initial_owner_address>" "<implementation_address>"

[⠢] Compiling...
[⠒] Compiling 80 files with 0.8.25
[⠘] Solc 0.8.25 finished in 11.32s
Compiler run successful!
Deployer: 0xE2328a0A7393914b2f8C4751b709Aa39fE9b7C2f
Deployed to: 0x3b41c6Ee950B27A224ACf546f721BD925f01cA74
Transaction hash: 0x9432b2bb50294d13158ea63d9bd619807dbcfd229bdd35f40a071a3ae737061b

factory_contract_address - address of the Factory contract(deployed to) from command above

> cast send --rpc-url <your_rpc_url> --private-key=<your_private_key> <factory_contract_address> 'deploy(address)' <address_owner>

Contracts

Allocator.sol

Upgradeable smart contract to manage the allowance.

Functions

allowance(address allocator) public view returns (uint256 amount)

Returns the amount of the allowance for the notary.

  • Parameters:

    • allocator: Address of the notary whose allowance is queried.

  • Returns:

    • amount: The amount of allowance for the specified notary.

addAllowance(address allocatorAddress, uint256 amount) external onlyOwner

Function to add an allowance for the notary. Invoked only by the contract owner.

  • Parameters:
    • allocatorAddress: Address of the notary to add allowance for.
    • amount: The amount of allowance to add.

setAllowance(address allocatorAddress, uint256 amount) external onlyOwner

Function to set an allowance for the notary. Invoked only by the contract owner. Allowance can be set to 0. To set an allowance bigger than 0, allowance before must equal 0.

  • Parameters:
    • allocatorAddress: Address of the notary to set allowance for.
    • amount: The amount of allowance to set.

addVerifiedClient(bytes calldata clientAddress, uint256 amount) external

Function to add allowance to the client. Invoked only by the notary.

  • Parameters:
    • clientAddress: Address of the client to add allowance for.
    • amount: The amount of allowance to add.

getAllocators() external view returns (address[] memory allocators)

Function to return all active notaries.

  • Returns:
    • allocators: Array of addresses representing all active notaries.

Factory.sol

Smart contract for deploying and managing instances of Allocator.sol

Constructor

constructor(address initialOwner, address implementation_)

Constructor to initialize the Factory contract.

  • Parameters:
    • initialOwner: Address of the initial owner of the contract.
    • implementation_: Address of the implementation contract.

Functions

getContracts() external view returns (address[] memory)

Function to retrieve the addresses of all deployed contracts.

  • Returns:
    • address[] memory: Array of addresses representing deployed contracts.

deploy(address owner) external

Function to deploy a new instance of a contract.

  • Parameters:
    • owner: Address of the owner for the new instance.

setImplementation(address implementation_) external onlyOwner

Function to set the implementation contract address.

  • Parameters:
    • implementation_: Address of the new implementation contract.

Client.sol

The Client contract facilitates the management of DataCap allocations. It enables the allocator to set and modify client allowances, manage lists of authorized storage providers for each client, and define distribution constraints to ensure fair allocation. Clients can transfer their allocated DataCap to permitted storage providers, adhering to the configured allowances and distribution rules.

Functions

transfer(DataCapTypes.TransferParams calldata params) external

Transfers DataCap tokens from the client to the storage provider. This function can only be called by the client.

  • Parameters:
    • params: The parameters for the transfer.

addAllowedSPsForClient(address client, uint64[] calldata allowedSPs_) external onlyOwner

Adds storage providers to the allowed list for a specific client. Can only be called by the owner.

  • Parameters:
    • client: The address of the client.
    • allowedSPs_: The list of storage providers to add.

removeAllowedSPsForClient(address client, uint64[] calldata disallowedSPs_) external onlyOwner

Removes storage providers from the allowed list for a specific client. Can only be called by the owner.

  • Parameters:
    • client: The address of the client.
    • disallowedSPs_: The list of storage providers to remove.

allowances(address client) external view returns (uint256 allowance)

Returns the current allowance of the specified client.

  • Parameters:
    • client: The address of the client.
  • Returns:
    • allowance: The allowance of the client.

clientSPs(address client) external view returns (uint256[] memory providers)

Retrieves the list of storage providers allowed for the specified client.

  • Parameters:
    • client: The address of the client.
  • Returns:
    • providers: List of allowed storage providers.

clientConfigs(address client) external view returns (uint256 maxDeviationFromFairDistribution)

Returns the maximum allowed deviation from fair distribution for a specific client.

  • Parameters:
    • client: The address of the client.
  • Returns:
    • maxDeviationFromFairDistribution: Maximum deviation from fair distribution.

totalAllocations(address client) external view returns (uint256 allocations)

Retrieves the total sum of allocations for the specified client.

  • Parameters:
    • client: The address of the client.
  • Returns:
    • allocations: The total allocations of the client.

clientAllocationsPerSP(address client) external view returns (uint256[] memory providers, uint256[] memory allocations)

Retrieves the total allocations per storage provider for the specified client.

  • Parameters:
    • client: The address of the client.
  • Returns:
    • providers: List of storage providers.
    • allocations: Allocations per storage provider.

setClientMaxDeviationFromFairDistribution(address client, uint256 maxDeviation) external onlyOwner

Sets the maximum allowed deviation from a fair distribution of data between storage providers for a specific client. Can only be called by the owner.

  • Parameters:
    • client: The address of the client.
    • maxDeviation: Maximum allowed deviation. 0 indicates no slack, and DENOMINATOR represents 100% (based on total allocations of the user).

increaseAllowance(address client, uint256 amount) external onlyOwner

Increases the allowance for a client. Can only be called by the owner.

  • Parameters:
    • client: The client that will receive allowance.
    • amount: The amount to increase the allowance by.

decreaseAllowance(address client, uint256 amount) external onlyOwner

Decreases the allowance for a client. Can only be called by the owner.

  • Parameters:
    • client: The client whose allowance is to be decreased.
    • amount: The amount to decrease the allowance by.

BeaconProxyFactory.sol

Factory for deploying new instances of Client Contract. Factory owner can update the implementation used for deploying new instances.

Constructor

constructor(address logic_)

Constructor to initialize the BeaconProxyFactory contract.

  • Parameters:
    • logic_: Address of the implementation contract.

Functions

create(address manager_) external

Creates a new instance of an upgradeable contract.

  • Parameters:
    • manager_: Address of the contract manager.

ABIs

Related tools

Filecoin PLUS

Website to communicate with the smart contract

contract-metaallocator-cli

CLI to communicate with the smart contract