https://github.com/xrplwin/xrpl-nfttxmutationparser
Parse NFT and URI transaction to context aware object providing direction, token id and roles.
https://github.com/xrplwin/xrpl-nfttxmutationparser
nft nftoken parser php uri uritoken xahau xrpl
Last synced: over 1 year ago
JSON representation
Parse NFT and URI transaction to context aware object providing direction, token id and roles.
- Host: GitHub
- URL: https://github.com/xrplwin/xrpl-nfttxmutationparser
- Owner: XRPLWin
- License: mit
- Created: 2023-03-02T18:00:40.000Z (over 3 years ago)
- Default Branch: main
- Last Pushed: 2024-05-17T06:40:27.000Z (about 2 years ago)
- Last Synced: 2025-03-04T20:39:13.174Z (over 1 year ago)
- Topics: nft, nftoken, parser, php, uri, uritoken, xahau, xrpl
- Language: PHP
- Homepage:
- Size: 127 KB
- Stars: 1
- Watchers: 0
- Forks: 0
- Open Issues: 2
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
[](https://github.com/XRPLWin/XRPL-NFTTxMutationParser/actions/workflows/main.yml)
[](https://github.com/XRPLWin/XRPL-NFTTxMutationParser/blob/main/LICENSE)
[](https://packagist.org/packages/xrplwin/xrpl-nfttxmutationparser)
# XRPL NFT Transaction Mutation Parser for PHP
## Supporting networks
- XRPL
- Xahau
## Description
Parses NFToken and URIToken (referred as NFT) Transactions (`NFTokenMint`, `URITokenMint`, `NFTokenBurn`, `URITokenBurn`, `NFTokenAcceptOffer`, `URITokenBuy`, `NFTokenCancelOffer`, `URITokenCancelSellOffer`, `NFTokenCreateOffer`, `URITokenCreateSellOffer`, `Remit`) with account context and returns affected NFT, direction that NFT was transferred, minted or destroyed, and outputs roles referencing account has in specific transaction.
With this parser you can find out what has happened with referencing account after transaction was executed. For example when token is minted - parser will output token ID and direction IN, this means referenced account was minter and new token is added to reference account ownership.
**Remit (XLS-55)**
Remit Transaction Type can mint a single URIToken which is present in this transaction like any other NFT. Additionally Remit can transfer none, one or more existing URIToken-s from Account to Destination, those tokens are present in `nfts` and `ref.nfts` array key, sending Account has role 'SELLER' and receiver Destination has role 'OWNER'.
What is checked:
- **Token id** - affected token ID in question
- **Token direction** - minted - IN, burned, OUT, sold - OUT, bought - IN
- **Roles** - role of referencing account in this transaction, is it minter, burner, seller, buyer, broker, or issuer
- **Remitted URITokens** - list of tokens transferred in `Remit` transaction type
Note about NFToken (XLS-20) issuer:
Issuer can only happen in `NFTokenAcceptOffer` transaction type, it is extracted from modified AccountRoot node by checking if balance has been changed. If yes then this account gained percentage of sale, and it is issuer of NFToken.
### Note
This package is provided as is, please test it yourself first.
Found a bug? [Report issue here](https://github.com/XRPLWin/XRPL-NFTTxMutationParser/issues/new)
## Requirements
- PHP 8.1 or higher
- [Composer](https://getcomposer.org/)
## Installation
To install run
```
composer require xrplwin/xrpl-nfttxmutationparser
```
## Usage
```PHP
use XRPLWin\XRPLNFTTxMutatationParser\NFTTxMutationParser;
$txResult = [
"Account" => "rBcd..."
"Fee" => "1000",
//...
];
$parser = new NFTTxMutationParser(
"rAbc...", //This is reference account
(object)$txResult //This is transaction result
);
$parsedTransaction = $parser->result();
print_r($parsedTransaction);
/*
┐
├ Output for $parsedTransaction:
├ Array (
├ [nft] => 00082710...
├ [nfts] => []
├ [context] => null
├ [ref] => Array
├ (
├ [account] => rAbc...
├ [nft] => 00082710...
├ [nfts] => []
├ [direction] => IN
├ [roles] => Array
├ (
├ [0] => OWNER
├ )
├ )
├ )
┴
*/
```
## Response
| Key | Type | Description |
| ------------- | ------------- | ------------- |
| nft | ?String | NFToken or URIToken always present in types: `NFTokenMint`, `NFTokenBurn`, `NFTokenAcceptOffer`, `NFTokenCreateOffer`, `URI*`, null in `Remit` if there is no token minted |
| nfts | Array | NFTokens transferred in Remit transaction type (not including Minted token) |
| context | ?String | Context of transaction (specifically offers). One of: `null`,`"BUY"`,`"SELL"`,`"BROKERED"` |
| ref.account | String | Reference account |
| ref.nft | ?String | NFTokenID or URIToken which changed ownership depending on direction for reference account including minted URIToken in Remit |
| ref.nfts | Array | URITokens which changed ownership depending on direction for reference account in Remit transaction only, NFTokens transferred in Remit transaction type (not including Minted token) |
| ref.direction | String | One of: `"IN"`,`"OUT"`,`"UNKNOWN"` |
| ref.roles | Array | Array of roles reference account has in this transaction, possible roles: `"UNKNOWN"`, `"OWNER"`, `"MINTER"`, `"BURNER"`, `"BUYER"`, `"SELLER"`, `"BROKER"`, `"ISSUER"` |
## Running tests
Run all tests in "tests" directory.
```
composer test
```
or
```
./vendor/bin/phpunit --testdox
```
## Demo
See this in action on [XRPLWin Playground](https://playground.xrpl.win/play/xrpl-nft-transaction-mutation-parser)