Lunar Assistant Guide
Search…
Getting Started
User Guide
Reference
About
Token Permissioned Roles
Guide to setting up token permissioned roles.
When configuring token permissioned roles, the following commands are your friend:
/lunar-configure add-nft-rule
Use
/lunar-configure add-nft-rule to add an nft permissioned role to your server. Each nft permissioned role is composed of the following properties:- nft-address (required) : The contract address against which to check for nft ownership
- role (required) : The role to give to users which meet this rule.
- quantity (optional, 1 by default) : The quantity of matching nfts that a user must hold in order to meet the rule.
- token-ids (optional, all by default) : A list of token ids that the rule is restricted to. This can be used to add nft trait based roles. Calculate the list of token ids specific to a trait (galactic glitch for example) and then pass these token ids in when creating a rule.
Example 1:
/lunar-configure add-nft-rule nft-address: terra103z9cnqm8psy0nyxqtugg6m7xnwvlkqdzm4s4k role: @Galactic CitizenThis adds a rule which grants anybody with at least one galactic punk (the nft address points to the galactic punk contract) the role
Galactic CivilianExample 2:
/lunar-configure add-nft-rule nft-address: terra103z9cnqm8psy0nyxqtugg6m7xnwvlkqdzm4s4k role: @Galactic Glitch quantity: 2 token-ids:["1","2","3","4","5","7"]This adds a rule which grants anybody with at least two galactic punks with the specified token ids the role
Galactic Glitch 
The output of running
/lunar-configure add-rule/lunar-configure add-staked-nft-rule
Use
/lunar-configure add-staked-nft-rule to add a staked nft permissioned role to your server. Each staked nft permissioned role is composed of the following properties:- staked-nft-address (required) : The contract address against which to check for staked nft ownership
- role (required) : The role to give to users which meet this rule.
- quantity (optional, 1 by default) : The quantity of matching staked nfts that a user must hold in order to meet the rule.
- token-ids (optional, all by default) : A list of token ids that the rule is restricted to. This can be used to add nft trait based roles. Calculate the list of token ids specific to a trait (galactic glitch for example) and then pass these token ids in when creating a rule.
Example 1:
/lunar-configure add-staked-nft-rule staked-nft-address: terra10t4pgfs6s3qeykqgfq9r74s89jmu7zx5gfkga5 role: @Galactic CitizenThis adds a rule which grants anybody with at least one staked galactic punk (the nft address points to the galactic punk staking contract) the role
Galactic CitizenExample 2:
/lunar-configure add-staked-nft-rule staked-nft-address: terra10t4pgfs6s3qeykqgfq9r74s89jmu7zx5gfkga5 role: @Galactic Glitch quantity: 2 token-ids:["1","2","3","4","5","7"]This adds a rule which grants anybody with at least two staked galactic punks with the specified token ids the role
Galactic Glitch /lunar-configure add-cw20-rule
Use
/lunar-configure add-cw20-rule to add a cw20 permissioned role to your server. Each cw20 permissioned role is composed of the following properties:- cw20-address (required) : The contract address against which to check for cw20 ownership
- role (required) : The role to give to users which meet this rule.
- quantity (optional, 1 by default) : The quantity of matching cw20 tokens that a user must hold in order to meet the rule.
Example 1:
/lunar-configure add-cw20-rule cw20-address: terra1l0y8yg0s86x299nqw0p6fhh7ngex3r4phtjeuq role: @SDollar Holder quantity: 10000This adds a rule which grants anybody with at least 10000 SDollars (the cw20 address points to the sdollar contract) the role
SDollar Holder/lunar-configure add-api-rule
Use
/lunar-configure add-api-rule to add an api permissioned role to your server. Each api permissioned role is composed of the following properties:
- api-url (required) : The url of your custom api against which to check for permission.
- role (required) : The role to give to users which meet this rule.
API Specifications:
- the api must accept a wallet address and return its response in the following JSON format: {"allowed":true}
- the url must contain $(wallet) which is an identifier that will be replaced by the actual wallet address to check at runtime.
Example 1: /lunar-configure add-api-rule api-url: https://stations.levana.finance/api/factions/free-martians?wallet=$(wallet) role: @Free Martian
This adds a rule which grants anybody for which the api returns true the role Free Martian
/lunar-configure view-rules
Use
/lunar-configure view-rules to view the rules currently configured for your server. Example response:
The ouput of running
/lunar-configure view-rules/lunar-configure remove-rule
Use
/lunar-configure remove-rule to remove a previously added rule. Example response:
The output of running
/lunar-configure remove-ruleFurther Reading
To learn more about lunar assistant configuration commands, see the following reference: