		@@ -1,7 +0,18 @@
		# Perpetual Protocol
		# Perpetual Protocol <img src="https://github.com/perpetual-protocol/perp-contract/blob/develop/docs/Perpetual.png" width="40">

		Please refer Perpetual Protocol [documentation](https://docs.perp.fi/) for more details.
		Perpetual Protocol is a decentralized perpetual contract protocol for every asset, made possible by a Virtual Automated Market Maker (henceforth referred to as a “vAMM” or “vAMMs”).
		>For those who aren’t familiar with perpetual contracts: A perpetual contract is a derivative similar to a futures contract but without an expiry date. For conventional futures contracts such as WTI, the contract’s price will gradually converge with the underlying asset’s spot market price as the expiry date approaches. Perpetual contracts are futures contracts that automatically roll over on a given time period, e.g. 1 hour, 8 hours, etc. In order to keep the perpetual contract in line with the underlying index, one side of the market pays the other a funding rate. The funding rate effectively implies a cost of capital and the steepness of the futures curve. You can learn more about how funding works by reading our [documentation](https://docs.perp.fi/).

		Welcome contributions to this project. Please join our [Discord](https://discord.com/channels/687397941383659579/707845517610319893) to discuss.
		##### Key features of the Perpetual Protocol include:
		- 10x Leverage On-Chain Perpetual Contacts
		Traders can trade with up to 10x leverage long or short, with transparent fees and 24/7 guaranteed liquidity.
		- Go Long or Short on Any Asset
		Every asset can be supported on Perpetual Protocol. Whether it's gold, fiat, BTC, BCH, ETH, ERC-20s, XRP, EOS, LTC, ZEC, XMR, and more - Perpetual Protocol can support it all. All that Perpetual Protocol requires is a price feed for the underlying asset from an oracle.
		- Lower Slippage than Other AMMs
		Traders on constant product (x*y=k) market makers like Uniswap suffer higher slippage than traders on centralized exchanges (CEXs) because k is capped by the liquidity provided. Perpetual Protocol’s vAMM can set K algorithmically to provide lower slippage to traders.

		Please refer to the [Perpetual Protocol documentation](https://docs.perp.fi/) for more details.

		Welcome to contribute to this project. Please join our [Discord](https://discord.gg/mYKKRTn) to discuss.

		## Local development and testing
		@@ -26,4 +37,6 @@ ### Requirements

		To learn more use cases, please refer to the [development guide](https://docs.perp.fi/sdk-documentation/smart-contract-javascript-dev-guide).

		### Testing
		Run all the test cases,
		To run all the test cases,
		```
		@@ -33,15 +46,14 @@ npm run test

		If you only want to run partial test cases, add `.only` at test cases or test sections. For example,
		If you only want to run partial test cases, add `.only` and pass the title of test cases or test sections. For example,
		```
		describe.only("Amm Unit Test", () => {
		...
		}

		or

		describe.only("Amm Unit Test", () => { ... }
		```
		or
		```
		it.only("admin open amm", async () => { ... }
		```

		Test cases can be found in the `./tests` folder.

		## License
		GPL3.0 or later

@perp/contract - npm Package Compare versions

Improved metrics