search

filecoin-project / filecoin-solidity

Filecoin Solidity API Library
Other
17 stars 11 forks source link

fix README.md #57

Closed zhiqiangxu closed 3 months ago

zhiqiangxu commented 3 months ago

The generated library for foundry doesn't have filecoin-project/ in path.

image
snissn commented 3 months ago

Thank you @zhiqiangxu I agree with your change and am merging your PR.

Below is my local verification that the forge install directory should be lib/filecoin-solidity:

mikers@mikers-B560-DS3H-AC-Y1:~/dev/filecoin-project$ mkdir test-57
mikers@mikers-B560-DS3H-AC-Y1:~/dev/filecoin-project$ cd test-57/
mikers@mikers-B560-DS3H-AC-Y1:~/dev/filecoin-project/test-57$ ^C
mikers@mikers-B560-DS3H-AC-Y1:~/dev/filecoin-project/test-57$ forge init
Initializing /home/mikers/dev/filecoin-project/test-57...
Installing forge-std in /home/mikers/dev/filecoin-project/test-57/lib/forge-std (url: Some("https://github.com/foundry-rs/forge-std"), tag: None)
Cloning into '/home/mikers/dev/filecoin-project/test-57/lib/forge-std'...
remote: Enumerating objects: 2310, done.
remote: Counting objects: 100% (2305/2305), done.
remote: Compressing objects: 100% (799/799), done.
remote: Total 2310 (delta 1529), reused 2156 (delta 1434), pack-reused 5
Receiving objects: 100% (2310/2310), 664.74 KiB | 1.73 MiB/s, done.
Resolving deltas: 100% (1529/1529), done.
    Installed forge-std v1.8.2
    Initialized forge project
mikers@mikers-B560-DS3H-AC-Y1:~/dev/filecoin-project/test-57$ forge install filecoin-project/filecoin-solidity
Installing filecoin-solidity in /home/mikers/dev/filecoin-project/test-57/lib/filecoin-solidity (url: Some("https://github.com/filecoin-project/filecoin-solidity"), tag: None)
Cloning into '/home/mikers/dev/filecoin-project/test-57/lib/filecoin-solidity'...
remote: Enumerating objects: 3611, done.
remote: Counting objects: 100% (735/735), done.
remote: Compressing objects: 100% (142/142), done.
remote: Total 3611 (delta 638), reused 604 (delta 587), pack-reused 2876
Receiving objects: 100% (3611/3611), 18.79 MiB | 13.71 MiB/s, done.
Resolving deltas: 100% (2423/2423), done.
Submodule 'lib/buffer' (https://github.com/ensdomains/buffer) registered for path 'lib/buffer'
Submodule 'lib/forge-std' (https://github.com/foundry-rs/forge-std) registered for path 'lib/forge-std'
Submodule 'lib/openzeppelin-contracts-upgradeable' (https://github.com/OpenZeppelin/openzeppelin-contracts-upgradeable) registered for path 'lib/openzeppelin-contracts-upgradeable'
Submodule 'lib/solidity-cborutils' (https://github.com/smartcontractkit/solidity-cborutils) registered for path 'lib/solidity-cborutils'
Cloning into '/home/mikers/dev/filecoin-project/test-57/lib/filecoin-solidity/lib/buffer'...
remote: Enumerating objects: 254, done.        
remote: Counting objects: 100% (31/31), done.        
remote: Compressing objects: 100% (28/28), done.        
remote: Total 254 (delta 3), reused 7 (delta 0), pack-reused 223        
Receiving objects: 100% (254/254), 888.28 KiB | 1.68 MiB/s, done.
Resolving deltas: 100% (121/121), done.
Cloning into '/home/mikers/dev/filecoin-project/test-57/lib/filecoin-solidity/lib/forge-std'...
remote: Enumerating objects: 2310, done.        
remote: Counting objects: 100% (2305/2305), done.        
remote: Compressing objects: 100% (808/808), done.        
remote: Total 2310 (delta 1531), reused 2145 (delta 1425), pack-reused 5        
Receiving objects: 100% (2310/2310), 659.77 KiB | 1.79 MiB/s, done.
Resolving deltas: 100% (1531/1531), done.
Cloning into '/home/mikers/dev/filecoin-project/test-57/lib/filecoin-solidity/lib/openzeppelin-contracts-upgradeable'...
remote: Enumerating objects: 51906, done.        
remote: Counting objects: 100% (9400/9400), done.        
remote: Compressing objects: 100% (2259/2259), done.        
remote: Total 51906 (delta 7589), reused 8375 (delta 7058), pack-reused 42506        
Receiving objects: 100% (51906/51906), 28.18 MiB | 13.66 MiB/s, done.
Resolving deltas: 100% (37494/37494), done.
Cloning into '/home/mikers/dev/filecoin-project/test-57/lib/filecoin-solidity/lib/solidity-cborutils'...
remote: Enumerating objects: 493, done.        
remote: Counting objects: 100% (93/93), done.        
remote: Compressing objects: 100% (35/35), done.        
remote: Total 493 (delta 77), reused 58 (delta 58), pack-reused 400        
Receiving objects: 100% (493/493), 737.63 KiB | 1.48 MiB/s, done.
Resolving deltas: 100% (248/248), done.
Submodule 'lib/ds-test' (https://github.com/dapphub/ds-test) registered for path 'lib/forge-std/lib/ds-test'
Cloning into '/home/mikers/dev/filecoin-project/test-57/lib/filecoin-solidity/lib/forge-std/lib/ds-test'...
remote: Enumerating objects: 313, done.        
remote: Counting objects: 100% (171/171), done.        
remote: Compressing objects: 100% (79/79), done.        
remote: Total 313 (delta 91), reused 132 (delta 83), pack-reused 142        
Receiving objects: 100% (313/313), 71.35 KiB | 785.00 KiB/s, done.
Resolving deltas: 100% (130/130), done.
Submodule 'lib/erc4626-tests' (https://github.com/a16z/erc4626-tests.git) registered for path 'lib/openzeppelin-contracts-upgradeable/lib/erc4626-tests'
Submodule 'lib/forge-std' (https://github.com/foundry-rs/forge-std) registered for path 'lib/openzeppelin-contracts-upgradeable/lib/forge-std'
Cloning into '/home/mikers/dev/filecoin-project/test-57/lib/filecoin-solidity/lib/openzeppelin-contracts-upgradeable/lib/erc4626-tests'...
remote: Enumerating objects: 11, done.        
remote: Counting objects: 100% (11/11), done.        
remote: Compressing objects: 100% (10/10), done.        
remote: Total 11 (delta 3), reused 7 (delta 1), pack-reused 0        
Receiving objects: 100% (11/11), 22.18 KiB | 267.00 KiB/s, done.
Resolving deltas: 100% (3/3), done.
Cloning into '/home/mikers/dev/filecoin-project/test-57/lib/filecoin-solidity/lib/openzeppelin-contracts-upgradeable/lib/forge-std'...
remote: Enumerating objects: 2310, done.        
remote: Counting objects: 100% (2305/2305), done.        
remote: Compressing objects: 100% (799/799), done.        
remote: Total 2310 (delta 1529), reused 2156 (delta 1434), pack-reused 5        
Receiving objects: 100% (2310/2310), 664.74 KiB | 1.85 MiB/s, done.
Resolving deltas: 100% (1529/1529), done.
Submodule 'lib/ds-test' (https://github.com/dapphub/ds-test) registered for path 'lib/openzeppelin-contracts-upgradeable/lib/forge-std/lib/ds-test'
Cloning into '/home/mikers/dev/filecoin-project/test-57/lib/filecoin-solidity/lib/openzeppelin-contracts-upgradeable/lib/forge-std/lib/ds-test'...
remote: Enumerating objects: 313, done.        
remote: Counting objects: 100% (171/171), done.        
remote: Compressing objects: 100% (79/79), done.        
remote: Total 313 (delta 91), reused 132 (delta 83), pack-reused 142        
Receiving objects: 100% (313/313), 71.35 KiB | 753.00 KiB/s, done.
Resolving deltas: 100% (130/130), done.
    Installed filecoin-solidity v1.1.2
mikers@mikers-B560-DS3H-AC-Y1:~/dev/filecoin-project/test-57$ ls lib/f
filecoin-solidity/ forge-std/         
mikers@mikers-B560-DS3H-AC-Y1:~/dev/filecoin-project/test-57$ ls lib/f
filecoin-solidity/ forge-std/         
mikers@mikers-B560-DS3H-AC-Y1:~/dev/filecoin-project/test-57$ ls lib/filecoin-solidity/
bin/               .env.example       .github/           hardhat.config.ts  lib-dev/           Makefile           README.md          testing/           
contracts/         foundry.toml       .gitignore         hh-test/           LICENSE-APACHE     package.json       remappings.txt     tsconfig.json      
docs/              .git               .gitmodules        lib/               LICENSE-MIT        .prettierrc        scripts/           
mikers@mikers-B560-DS3H-AC-Y1:~/dev/filecoin-project/test-57$ ls lib/filecoin-solidity/
bin/               .env.example       .github/           hardhat.config.ts  lib-dev/           Makefile           README.md          testing/           
contracts/         foundry.toml       .gitignore         hh-test/           LICENSE-APACHE     package.json       remappings.txt     tsconfig.json      
docs/              .git               .gitmodules        lib/               LICENSE-MIT        .prettierrc        scripts/           
mikers@mikers-B560-DS3H-AC-Y1:~/dev/filecoin-project/test-57$ ls lib/filecoin-solidity/
bin  contracts  docs  foundry.toml  hardhat.config.ts  hh-test  lib  lib-dev  LICENSE-APACHE  LICENSE-MIT  Makefile  package.json  README.md  remappings.txt  scripts  testing  tsconfig.json