Skip to content

Commit

Permalink
fix: updated README.md
Browse files Browse the repository at this point in the history
  • Loading branch information
capedcrusader21 committed Dec 13, 2024
1 parent 81ebd76 commit 5c72035
Showing 1 changed file with 12 additions and 1 deletion.
13 changes: 12 additions & 1 deletion packages/land-sale/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -28,6 +28,17 @@ contracts:

## Getting Started

### Overview
- Deploy new land presale contracts on any supported network.
- The process for initiating a new land sale requires deploying a separate smart contract for each sector using the EstateSaleWithAuth template. Update the existing script to deploy the contract.
- Deploy script path: `packages/deploy/deploy/1000_landsale/02_deploy_estate_sale.ts`
- Land presale requests involve one or more sector numbers. Confirm details if sector numbers don’t follow the usual increment by consulting the landsale-raffle squad.
- **NOTE**: Multiple sectors can be requested simultaneously.
- Some lands may include additional assets as optional bundles.
- Premium Lands will have additional steps documented once processed by the Blockchain Team.
- The landsale team typically requests an Amoy testnet deployment 1-2 weeks before mainnet.
- Relevant `.json` files will be provided by the landsale team.

### Step 1: Prepare for Deployment

- **Receive JSON Files**: The Landsale team will provide JSON files for bundles
Expand Down Expand Up @@ -111,4 +122,4 @@ To execute the deployment, run
- for live deployment: `yarn live:deploy --network NETWORK --tags TAG`
- where:
- `NETWORK` is the network name like: `polygon`, `mainet` etc
- `TAG` are the tags used to limit which deployment scripts will be executed
- `TAG` are the tags used to limit which deployment scripts will be executed

1 comment on commit 5c72035

@github-actions
Copy link

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Coverage for this commit

90.32%

Coverage Report
FileStmtsBranchesFuncsLinesUncovered Lines
packages/land-sale/contracts
   EstateSaleWithAuth.sol80.33%68.18%75%90.32%109, 125, 166, 166, 169, 259–266, 63, 74, 80, 88, 88, 88–89
packages/land-sale/contracts/common/Interfaces
   ERC1155.sol100%100%100%100%
   ERC165.sol100%100%100%100%
   ERC20.sol100%100%100%100%
   ERC20WithMetadata.sol100%100%100%100%
   ERC721.sol100%100%100%100%
   ERC721Events.sol100%100%100%100%
   ILandToken.sol100%100%100%100%

Please sign in to comment.