Skip to content

Commit

Permalink
clean outdated readme.
Browse files Browse the repository at this point in the history
  • Loading branch information
mr13tech committed Oct 8, 2023
1 parent 7260266 commit 646fc7a
Showing 1 changed file with 2 additions and 55 deletions.
57 changes: 2 additions & 55 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,23 +1,18 @@
# Copernic Core
# Copernic Space :: Core

Implementation of digital asset management system in ethereum based smart contracts;

## Prerequisites

### NODE

node + npm\yarn
node + yarn

# install is system specific
# tip: use nvm

https://github.com/nvm-sh/nvm

versions:

node: >= vv15.14.0
yarn: >= v1.22.10


### hardhat shorthand

Expand All @@ -28,51 +23,3 @@ https://hardhat.org/guides/shorthand.html
## Tests

hh test

## hh scripts&tasks
this are useful hardhat examples;

'mumbai' is default in all examples, because it is testnet.
'polygon' is an alias for mainnet. Change via `--network` option in `hh`


to use those, setup `secret.ts` file in root of the project. example:

```
const MUMBAI_ALCHEMY_API = ''
const MUMBAI_SEED = ''
const POLYGON_ALCHEMY_API = ''
const POLYGON_SEED = ''
export { MUMBAI_ALCHEMY_API, MUMBAI_SEED, POLYGON_ALCHEMY_API, POLYGON_SEED }
```


### SpaceMart
#### KYC

For any user to accept space asset (ERC1155), his address has to be on KYC list;
To add KYC address:

hh --network mumbai kycRegister:setStatus --kyc $KYC_ADDRESS --status true --client $USER_ADDRESS

#### Payload factory client

For any user to be able to create space payload - his address has to be granted client role on payload factory contract;

To grant client role:

```
hh --network mumbai payloadFactory:addClient --factory $PAYLOAD_FACTORY_ADDRESS --client $USER_ADDRESS
```

### Spaceibles

#### deploy asset

hh --network polygon run scripts/spaceibles/asset.deploy.ts

#### mint

hh --network mumbai spaceibles:mint --address $SPACEIBLE_ASSET_ADDRESS --balance 1 --cid testCidHash123 --royalties **0**

0 comments on commit 646fc7a

Please sign in to comment.