README.md

agp-npm

Package agp-npm is a gene parsing package for Axie Infinity.

The name agp stands for "Axie Gene Parser" which decodes the hex representation of an Axie's gene into a human readable format.

Documentation

For more detailed documentation, see agp-npm documentation.

Install

agp-npm runs on Node.js and is available as a NPM package.

npm install agp-npm

Usage

To get started, you'll first need to get the gene of an Axie in hex. You may use the Axie Infinity GraphQL endpoint to get this detail. For this example, let's use the hex 0x11c642400a028ca14a428c20cc011080c61180a0820180604233082

Let us create an AxieGene object from the hex string that we have.

JavaScript

256 Bit Genes

const { AxieGene } = require("agp-npm/dist/axie-gene"); // Defaults to HexType.Bit256
const axieGene = new AxieGene("0x11c642400a028ca14a428c20cc011080c61180a0820180604233082");

512 Bit Genes

const { AxieGene, HexType } = require("agp-npm/dist/axie-gene");
const hex = "0x280000000000010040412090830C0000000101942040440A00010190284082040001018C2061000A000101801021400400010180204080060001018418404008"
const axieGene = new AxieGene(hex, HexType.Bit512);

TypeScript

256 Bit Genes

const axieGene = new AxieGene("0x11c642400a028ca14a428c20cc011080c61180a0820180604233082");

512 Bit Genes

const hex = "0x280000000000010040412090830C0000000101942040440A00010190284082040001018C2061000A000101801021400400010180204080060001018418404008"
const axieGene = new AxieGene(hex, HexType.Bit512);

Gene Quality

You may also get the quality of the genes directly through the AxieGene object.

axieGene.getGeneQuality();

This object automatically handles the parsing of the hex value for you. You may simply use the accessors of the class to get the gene information that you want.

Here are the properties that you can get from the AxieGene object.

• genes
• cls
• region
• tag
• bodySkin
• pattern
• color
• eyes
• mouth
• ears
• horn
• back
• tail

Go Lang Support

I also released a similar package for Go. Do check it out!

Support the Author

Love this module? Feel free to buy me a coffee and motivate me to work on more stuffs like this!

Ronin Address: ronin:789c9b253eba265f0079e3ebcaaea2503eb31bb3
ETH Address: 0x9F50E3606caf22ff5E0E03F0eb02DE3Fa2786535
Paypal: paypal.me/shanemaglangit

Support does not need to have any monetary value. I would also appreciate if you leave a star!