https://github.com/yornaath/purescript-rmrk-parser
rmrk 2.0.0 protocol purescript parser
https://github.com/yornaath/purescript-rmrk-parser
Last synced: 4 months ago
JSON representation
rmrk 2.0.0 protocol purescript parser
- Host: GitHub
- URL: https://github.com/yornaath/purescript-rmrk-parser
- Owner: yornaath
- Created: 2022-02-28T15:17:50.000Z (over 3 years ago)
- Default Branch: master
- Last Pushed: 2022-01-11T13:55:28.000Z (over 3 years ago)
- Last Synced: 2025-03-15T17:43:14.846Z (7 months ago)
- Homepage:
- Size: 176 KB
- Stars: 0
- Watchers: 0
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# purescript-rmrk-parser
### RMRK 2.0.0 protocol purescript parser
RMRK protocoll parser and primitives in purescript.
## Quick Example
```purs
module Main where
import Prelude
import Data.Either (Either(..))
import Data.Maybe (Maybe(..))
import Data.Tuple (Tuple(..))
import Effect (Effect)
import Effect.Class.Console (log, logShow)
import Lib.Parsing.Combinators (ParserError(..), runParser)
import RMRK.Primitives.Version (Version(..))
import RMRK.Syntax (Stmt(..))
import RMRK.Syntax.Parser (parser)
main :: Effect Boolean
main = do
pure $ parse "rmrk::BUY::2.0.0::5105000-0aff6865bed3a66b-DLEP-DL15-00000001::H9eSvWe34vQDJAWckeTHWSqSChRat8bgKHG39GC1fjvEm7y"
== ( Right
$ BUY V2 (NFTId "5105000-0aff6865bed3a66b-DLEP-DL15-00000001")
(Just $ Recipient.Account $ Address "H9eSvWe34vQDJAWckeTHWSqSChRat8bgKHG39GC1fjvEm7y")
)
```
## Spec
Go to the spec repo for full documentation of the RMRK v2 spec.
[rmrk-team/rmrk-spec/tree/master/standards/rmrk2.0.0](https://github.com/rmrk-team/rmrk-spec/tree/master/standards/rmrk2.0.0)
The following **interactions** are implemented:
- [x] [ACCEPT](https://github.com/rmrk-team/rmrk-spec/blob/master/standards/rmrk2.0.0/interactions/accept.md) (Accept the addition of a new resource to an existing NFT, or
the additiona of a child into a parent NFT)
- [x] [BASE](https://github.com/rmrk-team/rmrk-spec/blob/master/standards/rmrk2.0.0/interactions/base.md) (Create a [Base](https://github.com/rmrk-team/rmrk-spec/blob/master/standards/rmrk2.0.0/entities/base.md))
- [x] [BUY](https://github.com/rmrk-team/rmrk-spec/blob/master/standards/rmrk2.0.0/interactions/buy.md) (Buy an NFT)
- [x] [CHANGEISSUER](https://github.com/rmrk-team/rmrk-spec/blob/master/standards/rmrk2.0.0/interactions/changeissuer.md) (Changing the issuer of a collection or base)
- [x] [BURN](https://github.com/rmrk-team/rmrk-spec/blob/master/standards/rmrk2.0.0/interactions/burn.md) (Burn an NFT)
- [x] [CREATE](https://github.com/rmrk-team/rmrk-spec/blob/master/standards/rmrk2.0.0/interactions/create.md) (Minting a collection of NFTs)
- [x] [EMOTE](https://github.com/rmrk-team/rmrk-spec/blob/master/standards/rmrk2.0.0/interactions/emote.md) (Send a reaction/emoticon)
- [x] [EQUIP](https://github.com/rmrk-team/rmrk-spec/blob/master/standards/rmrk2.0.0/interactions/equip.md) (Equip a child NFT into a parent's slot, or unequip)
- [x] [EQUIPPABLE](https://github.com/rmrk-team/rmrk-spec/blob/master/standards/rmrk2.0.0/interactions/equippable.md) (Changes the list of equippable collections on a
base's part)
- [x] [LOCK](https://github.com/rmrk-team/rmrk-spec/blob/master/standards/rmrk2.0.0/interactions/lock.md) (Locking a collection)
- [x] [MINT](https://github.com/rmrk-team/rmrk-spec/blob/master/standards/rmrk2.0.0/interactions/mint.md) (Minting an NFT inside a collection)
- [x] [LIST](https://github.com/rmrk-team/rmrk-spec/blob/master/standards/rmrk2.0.0/interactions/list.md) (List an NFT for sale)
- [x] [SEND](https://github.com/rmrk-team/rmrk-spec/blob/master/standards/rmrk2.0.0/interactions/send.md) (Sending an NFT to a recipient)
- [x] [RESADD](https://github.com/rmrk-team/rmrk-spec/blob/master/standards/rmrk2.0.0/interactions/resadd.md) (Add a new resource to an NFT as the collection issuer)
- [x] [SETPROPERTY](https://github.com/rmrk-team/rmrk-spec/blob/master/standards/rmrk2.0.0/interactions/setproperty.md) (Set a custom value on an NFT)
- [x] [SETPRIORITY](https://github.com/rmrk-team/rmrk-spec/blob/master/standards/rmrk2.0.0/interactions/setpriority.md) (Set a different order of resource priority)
- [x] [THEMEADD](https://github.com/rmrk-team/rmrk-spec/blob/master/standards/rmrk2.0.0/interactions/themeadd.md) (Add a new theme to a base)
## Docs
Find the docs at [Pursuit](https://pursuit.purescript.org/packages/purescript-rmrk-parser)
## Goal
Write a dumb protocol parser that parses RMRK strings to strong rich types. Spec of protocol consolidation is not defined or handled in this package.
### Run Tests
```bash
npm run test
```