/configure-tokenroles metadatafilter add

With this metadata filter applied to token role ID 13 (which we have set up to include the Spacebudz policy and a count of 1), everyone will get the respective Discord role @BudzCat if they have a Spacebudz cat. The metadata that goes with this filter is as follows and our attribute-path is simply a first-level attribute.

{
  "arweaveId": "Bqt7gfA8AbD2O5oQC_PG8yYdIQj9wQD3SUVP4rhw_uA",
  "image": "ipfs://QmVYZPT3WWfeBzzYhEamneAFvTe85hPF4QH1qFJBwjfwHA",
  "name": "SpaceBud #2729",
  "traits": [
    "Chestplate",
    "Belt",
    "Covered Helmet",
    "Axe",
    "Pistol"
  ],
  "type": "Cat"
}

With this metadata filter applied to token role ID 14 (which we have set up to include the Spacebudz policy and a count of 1), everyone will get the respective Discord role @AxeBud if they have a Spacebudz with "Axe" in the list of traits. With the attribute-path referencing a list of attributes (denoted by the [ ] brackets around the traits attribute content), we use the contains operator to match our text with the items in the list.

{
  "arweaveId": "Bqt7gfA8AbD2O5oQC_PG8yYdIQj9wQD3SUVP4rhw_uA",
  "image": "ipfs://QmVYZPT3WWfeBzzYhEamneAFvTe85hPF4QH1qFJBwjfwHA",
  "name": "SpaceBud #2729",
  "traits": [
    "Chestplate",
    "Belt",
    "Covered Helmet",
    "Axe",
    "Pistol"
  ],
  "type": "Cat"
}

In this case, we are applying TWO filters to our existing role for the Spacebudz policy. A user will now get the respective Discord role @DualWielder only if they have a Spacebudz that has both an "Axe" and a "Pistol" in the list of traits.

Alternative 1: By running /configure-tokenroles update and changing the aggregation-type to OR, everyone who either has a Spacebud with an Axe or a Spacebud with a Pistol will be considered.

Alternative 2: By running /configure-tokenroles update and changing the aggregation-type to ONE OF EACH, users only receive the role if they have one NFT matching each attribute. This means only people that own two Spacebudz, one with an Axe and one with a Pistol, would be assigned the role. This can be used to create roles for people that own "one of each type".

{
  "arweaveId": "Bqt7gfA8AbD2O5oQC_PG8yYdIQj9wQD3SUVP4rhw_uA",
  "image": "ipfs://QmVYZPT3WWfeBzzYhEamneAFvTe85hPF4QH1qFJBwjfwHA",
  "name": "SpaceBud #2729",
  "traits": [
    "Chestplate",
    "Belt",
    "Covered Helmet",
    "Axe",
    "Pistol"
  ],
  "type": "Cat"
}

If you have nested attributes like in this Tavern Squad NFT, you can simply access subattributes via a period. In our example we use attributes.Armor (not the case sensitive attribute names). In this case, we are filtering for any NFT where the Armor subattribute starts with the text Ice. This would include an Armor of the type Ice Chainmail but also any NFT with the Armor Ice Platemail or just Ice.

{
  "attributes": {
    "Armor": "Ice",
    "Back": "None",
    "Background": "Red",
    "Eyes": "Drowsy",
    "Face": "None",
    "Familiar": "None",
    "Head": "Flame",
    "Mouth": "Normal",
    "Race": "Human",
    "Racial": "Clean Shaven",
    "SkinTone": "C"
  },
  "id": 1813,
  "image": "ipfs://QmWcp43o3DguesCN1H5oJnwtZ32GTFM2F8Tb29qA2KsZiQ",
  "name": "Tavern Squad Adventurer #01813",
  "type": "image/png",
  "url": "https://tavernsquad.io"
}

For a more complicated attribute-path, we are using the DEADPXLZ project as an example. In this case, the attribute path value is properties[?(@.key=="type")].value, which means in the list of properties, we find the entry where the key attribute is type, and of that object, we then ask for the value attribute and check if it equals dead.

Vibrant allows for very complex attribute paths and leverages the power of JSONpath to query any part of your metadata. Find more information in one of the many JsonPath documentation pages . You can play around and test your attribute-path with our Metadata filter builder.

{
  "image": "ipfs://ipfs/QmRrFYTD2k8LVLkxdmyyqnuAbKBY664mkisEgMzw7rxZTZ",
  "name": "PXL#500",
  "properties": [
    {
      "key": "type",
      "value": "dead"
    },
    {
      "key": "length",
      "value": "long"
    }
  ],
  "src": "ipfs://ipfs/QmVsmMgvn28UxuPecwKSsd2cTnjgkw9ZKtyNoV566UEUXt",
  "tags": [
    "soul patch",
    "smoking"
  ],
  "type": "text/html"
}

When your attribute-path contains special characters or whitespace, you will need to use special square bracket expressions to match it. You will need to wrap your attribute name in brackets and double quotes, like in the above example. For your attribute path you would then use ["Attribute with Space"]. If you are nesting deeper and you have non-whitespace attributes in between, you can either use the same syntax or the dot-notation: ["Jaw & Teeth"].color["hue amount"] and ["Jaw & Teeth"]["color"]["hue amount"] are the same. Note there is no dot behind color in the first version.

We highly recommend to test your attribute-path with our Metadata filter builder first in this case.

{
  "Accessory": "Cross Bones",
  "Artist": "twitter.com/xjoshuajones",
  "Background": "Mint",
  "Base Skull": "Gold",
  "Eyes": "Robot Eyes",
  "Jaw & Teeth": "Gold",
  "Nemonium": "twitter.com/_nemonium",
  "Website": "nemo.global",
  "description": "Calvaria ",
  "name": "Skull_3439"
}

In this case, we are applying two filters with different token-weight to our existing role for the Spacebudz policy. A user will now get the respective Discord role @TenOrMore only if they have either two cats, ten non-cats or one cat and five non-cats (or anything else that adds up to ten or more).

Configuration: By running /configure-tokenroles update on our main role and changing the count to 10 and the aggregation-type to Any policy of the role, each NFT must match at least one filter, users only receive the role if they have a combined filtered token count of ten or more. This is best used with filters that are mutually exclusive, to enable weighted token roles based on metadata.

{
  "arweaveId": "Bqt7gfA8AbD2O5oQC_PG8yYdIQj9wQD3SUVP4rhw_uA",
  "image": "ipfs://QmVYZPT3WWfeBzzYhEamneAFvTe85hPF4QH1qFJBwjfwHA",
  "name": "SpaceBud #2729",
  "traits": [
    "Chestplate",
    "Belt",
    "Covered Helmet",
    "Axe",
    "Pistol"
  ],
  "type": "Cat"
}