Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/origyn-sa/origyn_nft
The Public Facing Origyn NFT Reference Implementation
https://github.com/origyn-sa/origyn_nft
Last synced: 5 days ago
JSON representation
The Public Facing Origyn NFT Reference Implementation
- Host: GitHub
- URL: https://github.com/origyn-sa/origyn_nft
- Owner: ORIGYN-SA
- License: apache-2.0
- Created: 2022-09-13T23:12:18.000Z (about 2 years ago)
- Default Branch: main
- Last Pushed: 2024-08-08T14:37:15.000Z (3 months ago)
- Last Synced: 2024-08-08T17:02:19.543Z (3 months ago)
- Language: Motoko
- Homepage:
- Size: 45.5 MB
- Stars: 25
- Watchers: 8
- Forks: 4
- Open Issues: 2
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
- awesome-internet-computer - Origyn NFT - Origyn NFT standard. (Fungible and Non-fungible Tokens (NFTs) / Interface Standards)
README
# origyn_nft_reference - v0.1.5
### Purpose
This repo contains the reference implementation of the ORIGYN NFT in motoko, the sales canister reference implementation, and the storage canister implementation that allows unlimited storage for NFT canisters.
### Usage
## NFT Canister
[NFT Canister API](./docs/nft-current-api.md)
[NFT Canister Sample Calls](./docs/audit.md)
[Market Place Integration](./docs/marketplace_integration.md)
## Sales Canister
[Overview](./docs/nft_sale.md)
## Getting up and running
### Testing
You will need the proper version of yes for your OS. (npm install -g yes)
yes yes | ./runners/test_runner.sh
### Produce an identity for deploying locally
1. You need to have an identity.pem and a seed.txt in your root directory. You can follow the instructions at https://forum.dfinity.org/t/using-dfinity-agent-in-node-js/6169/50 to produce these file. You should add these files to your git.ignore.
Navigate to my .dfx identities. → ~/.config/.dfx/identity
Create a new identity. → mkdir local-testing; cd local-testing
Download quill https://github.com/dfinity/quill.
Test that quill is installed correctly. → quill
Look up how to generate a key. → quill generate --help
Generate a key and seed file. → quill generate --pem-file identity.pem --seed-file seed.txt
Copy these files to your root directory and add to git.ignore.
To run deployment scripts you will also need to produce seed.prod.txt and identity.prod.pem for a deploying identity.
__You may need a git rest key__
https://docs.github.com/rest
You can put this key in gittoken.key
It may be necessary to download the default dapps.
### NFT Projects
The ./projects folder contains a sample NFT project with NFT assets for minting along with a deploy script. The deploy script should be invoked from the root of the project. For example:
```bash
yes yes | bash ./projects/bm/deploybm-local.sh
```
Reusable scripts are placed at the root of the ./projects folder.
### Git Large File Storage
This project contains video files that are stored in Git LFS. They are now downloaded when you clone the repo.
To download the videos, run the following:
```
git lfs install
git lfs fetch
git lfs checkout
```
Reference: https://git-lfs.github.com/
### deploy.js
Location: _./projects/deploy.js_.
Node script that stages and mints NFTs with the input of a JSON metadata file.
See also: https://github.com/ORIGYN-SA/minting-starter
### Logs & Metrics
[Logs and metrics documentation](./docs/logs_and_metrics.md)
### Audit
### Motoko base
It is important to note that every now and then there are new items in the motoko base library. One example of this is Timer. If you are using an older vesion of the motoko base library in vessel you will have an error complaining about a non existent Timer. In this repo we try to keep libs up-to-date, however, just be aware that from time to time you might need to change the upstream varible in the package-set.dhall to reflect the lastest motoko library.
[Audit document](./docs/audit.md)
### How to update Motoko Compiler
Origyn NFT version 0.1.5 needs Motoko Compiler version >= 0.10.1. This is included in DFX 0.15.1. If you have 0.15.0, see below:
Here are the instructions about how to do it:
- [Download MOC zip file for your Operating System](https://github.com/dfinity/motoko/releases/tag/0.10.2)
- Run the following command `dfx cache show` to get Motoko version directory installation
- Unzip file and copy `mo-ide, mo-doc, moc` files to the directory mentioned in step 2
- Make sure you give the right persmissions to those files
- Run `$(dfx cache show)/moc --version` to verify you have the downloaded version