Citizen: Difference between revisions

From Neo Tokyo Citizen Wiki
 
(69 intermediate revisions by 2 users not shown)
Line 1: Line 1:
[[File:citizen_1.png|300px|thumb|right|Citizen #1]]
<onlyinclude>[[File:3569.png|300px|thumb|right|Citizen #3569: Moto Angel. "To win the race first you have to grid up. To find the limit you have to be able to crash hard, get up, lick your wounds, heal, put it behind you, get back on and go full send. If your not willing to put it on the line you can never become champion!" —Race4TheWin]]


A Neo Tokyo Citizen is the NFT resulting from staking the three components (and an optional [[Neo_Tokyo_Vault_Card_(NEOTV)|Vault]]) in the [[Citizen#Contract_Address|Citizen Contract]]. While the component pieces of a citizen is text with computer code syntax, the Citizen NFT is an image based on the properties described in the text.  
A '''Neo Tokyo Citizen''' is the NFT created by staking the three components (and optional [[Neo_Tokyo_Vault_Card_(NEOTV)|Vault]]) in the [[Citizen#Contract_Address|Citizen Contract]]. While the component pieces of a citizen are shown as text with computer code syntax, the Citizen NFT is an image of a character based on the properties described in the text of the component parts.</onlyinclude>
 
A Citizen is distinct NFT from an ''[[Outer Citizen]]''.


__TOC__  
__TOC__  


==Properties==
==Properties==
The properties of the Citizen NFT are derived from its component [[Neo_Tokyo_Identities_(NEOTI)|Identity]], optional [[Neo Tokyo Part 2 Vault Card (NEOTV)|Vault Card]], [[Neo Tokyo Part 3 Item Caches (NTITEM)|Item Cache]], and [[Neo Tokyo Part 4 Land Deeds (NTLD)|Land]].
The properties of the Citizen NFT are derived from its component [[Neo_Tokyo_Identities_(NEOTI)|Identity]], [[Neo Tokyo Part 2 Vault Card (NEOTV)|Vault Card]], [[Neo Tokyo Part 3 Item Caches (NTITEM)|Item Cache]], and [[Neo Tokyo Part 4 Land Deeds (NTLD)|Land]].


==Creating a Citizen==
==Creating a Citizen==
Line 14: Line 16:
* [[Neo Tokyo Part 4 Land Deeds (NTLD)|Land Deed]] NFT
* [[Neo Tokyo Part 4 Land Deeds (NTLD)|Land Deed]] NFT


An optional [[Neo Tokyo Part 2 Vault Card (NEOTV)|Vault]] can be used to increase the $BYTE yield of the resulting Citizen.
[[Neo Tokyo Part 2 Vault Card (NEOTV)|Vaults]] were previously optional but, following [[migration]], must be used to assemble a new Citizen. Vaults increase the [[Bytes|$BYTE]] yield of the resulting Citizen.
[[File:S1_Info.jpg|800px|thumb|left]]
<br clear=all>
 
===Citizen Assembler===
{{:Citizen Assembler}}
<br clear=all>


===Appearance===
===Appearance===
The citizen's appearance depends on the characteristics described in the Identity and the Item Cache. The background of the resulting composite is based on Land Deed.
A citizen's appearance depends on the characteristics described in the Identity and the Item Cache and their gender. The background of the resulting composite is based on the Land Deed.
<gallery mode="packed-hover">
File:Citizen18.png|Citizen 18
File:Citizen218.png|Citizen 218
File:Citizen10.png|Citizen 10
File:Citizen4.png|Citizen 4
File:Citizen548.png|Citizen 548
File:Citizen1485.png|Citizen 1485
File:Citizen2368.png|Citizen 2368
File:Citizen2497.png|Citizen 2497
</gallery>


(Put a gallery of citizens here.)
<!--
====Changing a Citizen's Gender====
''TBA''
-->


===Benefits of Citizenship===
===Profile Picture===
* Becoming a citizen provides you with an appearance.
To get the highest-resolution version of a Citizen's profile picture, view the Citizen on the official website at https://neotokyo.codes/viewCitizens and download the WebP raster image or use the "Download cropped PFP" button.
* Your profile picture (PFP).
* You are able to accumulate credits.
* Dependent on your yield.
* Show off!
* N.B. Gender will be implemented shortly.


===How to Create a Citizen===
====Legacy Method to Generate a Profile Picture====
To create a citizen:
The legacy method to download a profile picture uses [[https://twitter.com/rcw_97 Ryan's]] CitGen service.


# Connect a wallet with the required NFTs to the Upload page of https://neotokyo.codes
To get a PNG image of your Citizen for a profile picture—instead of the individual SVG layers—use [https://rcw.io/ Ryan's] CitGen service at:
# Select the component NFTs to combine for the citizen through the website's interface
<br />
# Write a custom description (upload message)
<code>https://citgen.rcw.io/s1/1200x1200/1666</code>
# Press ''Upload''
<br />
# Confirm a transaction for each NFT that will be uploaded and a final upload transaction
...where <code>1666</code> is your Citizen number and <code>s1</code> is either s1 or s2 depending on if you are a [[Citizen]] or [[Outer Citizen]].


This will require wallet confirmation and significant gas fee because of the amount of data in the transaction.
The URL can be modified to:
* Change the size of the image... <code>https://citgen.rcw.io/s1/486x486/1666</code>
* See the female version of the Citizen (S1s only)... <code>https://citgen.rcw.io/s1/1200x1200/1666?female=true</code>
* Turn off the background... <code>https://citgen.rcw.io/s1/1200x1200/1666?no-bg=true</code>
* Add a custom color background (using hex color codes)... https://citgen.rcw.io/s1/1200x1200/1666?bg-color=849ef3
* Or, modify multiple features at the same time... <code>https://citgen.rcw.io/s1/486x486/1666?female=true&no-bg=true</code>


===Citizenship Number===
The instructions above will provide you with the full-figure of a Citizen. For a '''cropped profile''' picture featuring the face of a Citizen,
* Citizen numbers are consecutive and are automatically assigned.
use the alternate URL at:
* Citizen numbers will not be reused when a citizen is downloaded.
<br />
* A new consecutive citizen number is provided with each upload.
<code>https://citgen.rcw.io/s1/pfp/1666</code>
<br />
...where <code>1666</code> is your Citizen number and <code>s1</code> is either s1 or s2 depending on if you are a [[Citizen]] or [[Outer Citizen]].  


==Unstake and Disassemble a Citizen==
This URL can also be modified to:
Connect wallet containing the Citizen to the [[Citizen#Contract_Address|Citizen Contract address]]
* Add a custom color background (using hex color codes)... <code>https://citgen.rcw.io/s1/pfp/1666?bg-color=849ef3</code>


Enter the Citizen's ID in the <code>5. disassembleCitizen</code> function of the contract and ''Write.''
=====Using the Background Color to Reflect Citizen Rarity=====
Many Citizens use the custom background color to reflect their rank in Discord, using the following hex color codes:
* For Elite Citizens, <code>https://citgen.rcw.io/s1/pfp/1666?bg-color=faac27</code>
* For non-Elite Citizens, <code>https://citgen.rcw.io/s1/pfp/1666?bg-color=849ef3</code>
* And, for Outer Citizens, <code>https://citgen.rcw.io/s2/pfp/37?bg-color=b0d774</code>


==$BYTES==
===Rarity===
Each Citizen produces $BYTES tokens based on its component Identity's credit yield value and, if it was uploaded with a Vault, the Vault modifier.
A rarity score is given to each Citizen based on the combined score of its constituent NFTs. A Citizen with a top 500 rarity score is considered [[Elite_ranking|Elite]] and has access to the Metaverse Lounge channel in the Neo Tokyo Discord.


$BYTES are produced at a predictable rate based on when the Citizen was uploaded or when BYTES were last claimed.
Citizen rarity scores are listed at https://neotokyo.codes/trade


To maximize the BYTES claimed, the best practice is to claim them immediately after a BYTE was produced, at which point the start time for their production cycle is reset.
''For more information refer to the '''[[Rarity]]''' article.''


===Claimable Amount===
===Benefits of Citizenship===
To see the amount of accumulated $BYTES a Citizen can claim, you can either:
* Uploading component NFTs to the Citizen contract creates the Citizen profile picture.
* Enter the wallet address containing the Citizen at https://bytestobytes.com/
* Uploaded and staked Citizens yield $BYTES.
* Citizens can access exclusive Discord channels
* Citizens can create teams and join [[guilds]]
* Create a unique on-chain description for a Citizen at upload


Or
===Teams and Guilds===
[[Guilds]] were created as a means of distributing [[Chips]] prior to the [[Meta Tournament]]. There are 10 guilds and each guild is comprised of (up to) 200 Citizens. Guilds manage Citizens and Citizens manage their respective [[teams]].
A team is comprised of one Citizen manager and two [[Outer Citizen]] players.


* In the $BYTES contract (https://etherscan.io/address/0x7d647b1a0dcd5525e9c6b3d14be58f27674f8c95#readContract), in the ''Read Contract'' tab, <code>7. getTotalClaimable</code>, enter the wallet address containing the Citizen and click ''Query''.
===How to Upload a Citizen===
The process of creating a Citizen requires the necessary component NFTs to be staked in the Citizen contract. This process is also known as ''Uploading''.


===Claim $BYTES===
To upload a Citizen:
$BYTES must be claimed from the [[Citizen#Contract_Address|Citizen Contract]].


To claim $BYTES:
# Connect a wallet with the required NFTs to the Upload page of https://neotokyo.codes
# Select the component NFTs to combine for the citizen through the website's interface
# Write a custom description (upload message)
# Press ''Upload''
# Confirm a transaction for each NFT that will be uploaded and a final upload transaction
 
This will require wallet confirmation and significant gas fee because of the amount of data in the transaction.


# Connect a wallet with the required NFTs to the [[Citizen#Contract_Address|Citizen Contract]] via Etherscan.
It may be possible to upload via the latest contracts but there is no current documentation for this process.
# Select the ''Write Contract'' tab.
# Click ''Write'' beneath function <code>6. getReward</code>
# Confirm the transaction via the connected wallet.


===Open Vault to claim $BYTES===
===Citizenship Number===
$BYTES contained within a vault can be claimed if the user has access to an unopened vault and an identity that has not yet opened a vault in the same wallet. Each vault can only be opened once and each identity can only open one vault.
* A new Citizenship number is provided with each uploaded Citizen, adding +1 to the number of the last uploaded Citizen.
* Numbers are consecutive, based on upload, and are automatically assigned.
* Numbers will not be reused when a citizen is disassembled and reassembled.


To open a vault to claim $BYTES:
==Unstake and Disassemble a Citizen==
To swap out or trade a component NFT, the Citizen must be disassembled. This process returns the component pieces and the Citizen number is destroyed. The Citizen will no longer produce $BYTES, but all accumulated unclaimed $BYTES will still be available. The Citizen cannot be disassembled if it is [[Staking|staked]].


# Go to the Bytes Contract Address (https://etherscan.io/address/0x7d647b1A0dcD5525e9C6B3D14BE58f27674f8c95#writeContract)
Before disassembling, claim your $BYTES ([[Bytes#Claim_Bytes|instructions here]]).
# Connect a wallet with the required NFTs to the Bytes Contract Address
# Under function <code>7. openVaultBox</code> enter the corresponding identityTokenId and vaulBoxTokenId
# Click ''Write'' beneath function <code>7. openVaultBox</code>
# Confirm the transaction via the connected wallet.


===$BYTE Value on Cryptocurrency Exchanges===
To disassemble, connect the wallet containing the Citizen to the [[Citizen#Contract_Address|Citizen Contract address]]
https://www.dextools.io/app/ether/pair-explorer/0x3782a3425cd093d5cd0c5b684be72641e199029c


===Minting Neo Tokyo NFTs using $BYTES===
Navigate to the ''Write as Proxy'' tab, enter the Citizen's ID in the <code>8. disassembleCitizen</code> function of the contract and ''Write.''
$BYTES can be used to mint Neo Tokyo Citizen Component NFTs. At the time of writing, $BYTES can be used to mint the following:


* S1 Identity for 2000 $BYTES  
==$BYTES==
* S1 Land Deed for 500 $BYTES
Each Citizen produces [[Bytes|$BYTES]] tokens based on its component Identity's credit yield value and, if it was uploaded with a Vault, the Vault modifier. [[Outer Citizen|Outer Citizens]] do not yield $BYTES.


To use $BYTES to mint Neo Tokyo Citizen Components:
''To determine a Citizen's '''[[Bytes#Bytes_2.0_Yield|$BYTE yield]]''', information on '''[[Bytes#Claim_Bytes|claiming $BYTES]]''', or determining the '''[[Bytes#How_Many_$BYTES_Has_a_Citizen_Accumulated?|amount that a Citizen has produced]]'''; refer to the '''[[Bytes]]''' article.''


# Go to https://neotokyo.codes/upload
''For more information on '''[[Neo_Tokyo_Part_2_Vault_Card_(NEOTV)#Claiming_.24BYTES_From_Vault|claiming $Bytes from an unopened vault]]''', refer to '''[[Neo Tokyo Part 2 Vault Card (NEOTV)]]'''.''
# Connect a wallet with neccessary number of $BYTES to the website
# Select the component you would like to mint and confirm the transaction via the connected wallet
# After the transaction has completed you will receive an NFT with a tokenID, however the traits of the NFT will not be set until the seed is set for your token. To set the seed for the newly minted NFT:
# Go to https://etherscan.io/address/0x545d94525226545776e925b9d258026c6536f438#writeContract
# Connect a wallet with the required NFTs to the Contract
# Use function <code>2. setTokenSeed</code> with the following:
* <code>target (address)</code> is the address for the mint contract for the token. Note this is different from the verified token contract. See below for the current mint addresses.
* Current Bought Identities mint contract: 0x19815e26C3C8B7031E8a6901a73BCc1282A8F130
* Current Land mint contract: 0x3248d8F3d847aE6a3076E9BE923191Eaf0254851
* <code>tokenId (uint256)</code> is your tokenId that you wish to set the seed for.


==Contract Address==
https://etherscan.io/address/0xb9951b43802dcf3ef5b14567cb17adf367ed1c0f


Notes:
== See Also ==
* This is a temporary contract. Thrasher is working with the NT dev team to set up a proper solution. This contract contains a selfdestruct method that will be used once the official solution is in place.
* [[Outer Citizen]]
* You can call this contract from any address. It doesn't have to be the one that minted the token or the one containing your citizen. Anyone can call this on your behalf as well.
* [[Identities]]
* This contract can be used to set the seed for other NT tokens once that has been enabled (e.g. land, items, outer_ids, outer_lands, outer_items).
* [[Vaults]]
* [[Item caches]]
* [[Land deed]]
* [[Bytes]]
* [[Staking]]


==Contract Address==
== External Links ==
https://etherscan.io/address/0xb668beb1fa440f6cf2da0399f8c28cab993bdd65
[https://neotokyo.codes/citizens Neo Tokyo | Citizens] (official website)<br />
[https://magiceden.io/collections/ethereum/0xb9951b43802dcf3ef5b14567cb17adf367ed1c0f Neo Tokyo Citizens] Magic Eden collection<br />


==Open Sea Collection==
[[Category:NFT]]
https://opensea.io/collection/neotokyo-citizens
[[Category:S1]]

Latest revision as of 21:22, 1 March 2024

Citizen #3569: Moto Angel. "To win the race first you have to grid up. To find the limit you have to be able to crash hard, get up, lick your wounds, heal, put it behind you, get back on and go full send. If your not willing to put it on the line you can never become champion!" —Race4TheWin

A Neo Tokyo Citizen is the NFT created by staking the three components (and optional Vault) in the Citizen Contract. While the component pieces of a citizen are shown as text with computer code syntax, the Citizen NFT is an image of a character based on the properties described in the text of the component parts.

A Citizen is distinct NFT from an Outer Citizen.

Properties

The properties of the Citizen NFT are derived from its component Identity, Vault Card, Item Cache, and Land.

Creating a Citizen

Creating a Citizen requires:

Vaults were previously optional but, following migration, must be used to assemble a new Citizen. Vaults increase the $BYTE yield of the resulting Citizen.

S1 Info.jpg


Citizen Assembler

To review how available Neo Tokyo components would fit together, prior to assembly, try the Citizen Assembler.

The Citizen Assembler at, https://neotokyo.codes/assembler, offers a simple way to preview a Citizen's appearance and their resulting rarity score, ranking, and yield by selecting the preferred Identity, Vault, Item Cache, and Land Deed #'s.

The Citizen Assembler at https://neotokyo.codes/assembler


Appearance

A citizen's appearance depends on the characteristics described in the Identity and the Item Cache and their gender. The background of the resulting composite is based on the Land Deed.


Profile Picture

To get the highest-resolution version of a Citizen's profile picture, view the Citizen on the official website at https://neotokyo.codes/viewCitizens and download the WebP raster image or use the "Download cropped PFP" button.

Legacy Method to Generate a Profile Picture

The legacy method to download a profile picture uses [Ryan's] CitGen service.

To get a PNG image of your Citizen for a profile picture—instead of the individual SVG layers—use Ryan's CitGen service at:
https://citgen.rcw.io/s1/1200x1200/1666
...where 1666 is your Citizen number and s1 is either s1 or s2 depending on if you are a Citizen or Outer Citizen.

The URL can be modified to:

The instructions above will provide you with the full-figure of a Citizen. For a cropped profile picture featuring the face of a Citizen, use the alternate URL at:
https://citgen.rcw.io/s1/pfp/1666
...where 1666 is your Citizen number and s1 is either s1 or s2 depending on if you are a Citizen or Outer Citizen.

This URL can also be modified to:

Using the Background Color to Reflect Citizen Rarity

Many Citizens use the custom background color to reflect their rank in Discord, using the following hex color codes:

Rarity

A rarity score is given to each Citizen based on the combined score of its constituent NFTs. A Citizen with a top 500 rarity score is considered Elite and has access to the Metaverse Lounge channel in the Neo Tokyo Discord.

Citizen rarity scores are listed at https://neotokyo.codes/trade

For more information refer to the Rarity article.

Benefits of Citizenship

  • Uploading component NFTs to the Citizen contract creates the Citizen profile picture.
  • Uploaded and staked Citizens yield $BYTES.
  • Citizens can access exclusive Discord channels
  • Citizens can create teams and join guilds
  • Create a unique on-chain description for a Citizen at upload

Teams and Guilds

Guilds were created as a means of distributing Chips prior to the Meta Tournament. There are 10 guilds and each guild is comprised of (up to) 200 Citizens. Guilds manage Citizens and Citizens manage their respective teams. A team is comprised of one Citizen manager and two Outer Citizen players.

How to Upload a Citizen

The process of creating a Citizen requires the necessary component NFTs to be staked in the Citizen contract. This process is also known as Uploading.

To upload a Citizen:

  1. Connect a wallet with the required NFTs to the Upload page of https://neotokyo.codes
  2. Select the component NFTs to combine for the citizen through the website's interface
  3. Write a custom description (upload message)
  4. Press Upload
  5. Confirm a transaction for each NFT that will be uploaded and a final upload transaction

This will require wallet confirmation and significant gas fee because of the amount of data in the transaction.

It may be possible to upload via the latest contracts but there is no current documentation for this process.

Citizenship Number

  • A new Citizenship number is provided with each uploaded Citizen, adding +1 to the number of the last uploaded Citizen.
  • Numbers are consecutive, based on upload, and are automatically assigned.
  • Numbers will not be reused when a citizen is disassembled and reassembled.

Unstake and Disassemble a Citizen

To swap out or trade a component NFT, the Citizen must be disassembled. This process returns the component pieces and the Citizen number is destroyed. The Citizen will no longer produce $BYTES, but all accumulated unclaimed $BYTES will still be available. The Citizen cannot be disassembled if it is staked.

Before disassembling, claim your $BYTES (instructions here).

To disassemble, connect the wallet containing the Citizen to the Citizen Contract address

Navigate to the Write as Proxy tab, enter the Citizen's ID in the 8. disassembleCitizen function of the contract and Write.

$BYTES

Each Citizen produces $BYTES tokens based on its component Identity's credit yield value and, if it was uploaded with a Vault, the Vault modifier. Outer Citizens do not yield $BYTES.

To determine a Citizen's $BYTE yield, information on claiming $BYTES, or determining the amount that a Citizen has produced; refer to the Bytes article.

For more information on claiming $Bytes from an unopened vault, refer to Neo Tokyo Part 2 Vault Card (NEOTV).

Contract Address

https://etherscan.io/address/0xb9951b43802dcf3ef5b14567cb17adf367ed1c0f

See Also

External Links

Neo Tokyo | Citizens (official website)
Neo Tokyo Citizens Magic Eden collection