Add token docs #158

jackcmay · 2020-07-28T00:23:50Z

First cut of the token docs, please chime in if there are additional topics you'd like to see.

Fixes: #132

mvines · 2020-07-28T00:49:52Z

docs/src/token.md


-The project comprises:
+This program provides an interface and implementation that third parties can use to create and trade their tokens.


Suggested change

This program provides an interface and implementation that third parties can use to create and trade their tokens.

This program provides an interface and implementation that third parties can use to create and use their tokens.

Maybe make the first use => utilize?

mvines · 2020-07-28T00:53:09Z

docs/src/token.md

+
+## Interface
+
+The on-chain Token Program is written in Rust and available on crates.io as [spl-token](https://docs.rs/spl-token/1.0.2/spl_token/) documents the program's [instruction interface documentation](https://docs.rs/spl-token/1.0.2/spl_token/instruction/enum.TokenInstruction.html)


..as [spl-token](https://docs.rs/spl-token/1.0.2/spl_token/) documents.. -- something's wrong with the sentence here

CriesofCarrots

Wrap lines to 80 chars?

CriesofCarrots · 2020-07-28T01:02:12Z

docs/src/token.md

+
+[Client side bindings](https://github.com/solana-labs/solana-program-library/blob/master/token/js/client/token.js) are available in Javascript to load a Token Program and issue instructions
+
+[Javascript bindings](https://github.com/solana-labs/solana-program-library/blob/master/token/js/client/token.js) are available that support loading the Token Program on to a chain and issuing instructions.


Redundant with previous line

CriesofCarrots · 2020-07-28T01:07:51Z

docs/src/token.md


-The project comprises:
+This program provides an interface and implementation that third parties can use to create and trade their tokens.


Maybe make the first use => utilize?

CriesofCarrots · 2020-07-28T01:08:57Z

docs/src/token.md

+
+A new token type can be created by initializing a new Mint with the `InitializeMint` instruction.  The Mint is used to create or "Mint" new tokens, and these tokens are stored in Accounts.  A Mint is associated with each Account, which means that the total supply of a particular token type is equal to the balances of all the associated Accounts.
+
+A Mint can either be configured with a fixed-supply or not.  The total supply of a fixed-supply Mint is determined during initialization and deposited into a provided destination account.  A non-fixed-supply Mint also has an owner associated with it who has the authority to create new tokens in the future with the `MintTo` instruction.


Suggested change

A Mint can either be configured with a fixed-supply or not. The total supply of a fixed-supply Mint is determined during initialization and deposited into a provided destination account. A non-fixed-supply Mint also has an owner associated with it who has the authority to create new tokens in the future with the `MintTo` instruction.

A Mint can either be configured with a fixed or non-fixed supply. The total supply of a fixed-supply Mint is determined during initialization and deposited into a provided destination account. A non-fixed-supply Mint has an owner associated with it who has the authority to create new tokens in the future with the `MintTo` instruction.

I think it's worth mentioning burn instructions here because AFAICT you can still burn "fixed-supply" mint tokens which would decrease the supply

CriesofCarrots · 2020-07-28T01:11:57Z

token/README.md


-The project comprises:
+This program provides an interface and implementation that third parties can use to create and trade their own tokens.


Edit to match whatever you end up with in docs/src/token.md

Pull request has been modified.

* try running CI on big runners (solana-labs#126) * pack / unpack unit tests (solana-labs#135) * Isolated Tier Assets (solana-labs#134) * socialize loss feature (solana-labs#136) * Liquidation changes (solana-labs#139) * fully liquidate obligation liquidity if borrow value is < 1 and correctly handle dust * cap forgiveness amount wrt ctoken ratio (solana-labs#144) * On liq, assets must be repaid in order of borrow weight (decending) (solana-labs#141) * highest borrow weight liquidity must be repaid first * order borrows by (borrow weight, mint pubkey) and don't convert borrow weight to decimal * risk authority (solana-labs#142) * added risk authority to lending market, setLendingMarketOwnerAndConfig instruction, and fixed tests * modified update_reserve_config to use risk authority + tests * update comment math and handle program upgrade case for risk authority * add back compute units to tests (solana-labs#150) * adding compute unit limits * adding back compute units to test * Trilinear interest rates (solana-labs#149) * trilinear interest rates * edge case handling in Reserve::unpack * rename unhealthy utilization rate to max utilization rate * pr comment * Onchain metadata (solana-labs#151) * metadata * metadata * making LendingMarketMetadata zero copy * add lookup tables * review fixes * verify serialized tx size --------- Co-authored-by: 0xripleys <0xripleys@solend.fi> * 0xripleys dynamic liquidation bonus (solana-labs#147) * dynamic liquidation bonus * changing the behavior of protocol_liquidation_fee * comment add * tests for calculate protocol liquidation fee * adding more safeguards wrt bonus checking * add tests that use protocol_liquidation_fee * fix tests * PR fixes * changing protocol liquidation fee to be denominated in deca bps * support max borrows/withdraws (solana-labs#148) * support max withdraw and borrow * changing function signature of a test helper fn * tests for borrow/withdraw max on rate limiter * rebase fixes * PR fixes * rate limiter test fixes + fmt * audit fixes (solana-labs#154) * audit fixes * add test for refresh obligation filtering * moar audit fixes * break borrow weight tiebreaks by reserve pubkey, not mint (solana-labs#158) * fix version numbers, add name to library (solana-labs#159) * cli changes (solana-labs#155) * cli changes * cli fixes + adding subcommands to view accounts * clippy fixes * fix CI error --------- Co-authored-by: nope <83512286+nope-finance@users.noreply.github.com>

Add token docs

e76c6cd

mvines previously approved these changes Jul 28, 2020

View reviewed changes

CriesofCarrots reviewed Jul 28, 2020

View reviewed changes

feedback

4ba3d65

feedback

17ebcb4

jackcmay merged commit 691a213 into solana-labs:master Jul 28, 2020

jackcmay deleted the add-token-docs branch July 28, 2020 18:00

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Add token docs #158

Add token docs #158

jackcmay commented Jul 28, 2020 •

edited

Loading

mvines Jul 28, 2020

CriesofCarrots Jul 28, 2020

mvines Jul 28, 2020

CriesofCarrots left a comment

CriesofCarrots Jul 28, 2020

CriesofCarrots Jul 28, 2020

CriesofCarrots Jul 28, 2020

jstarry Jul 28, 2020

CriesofCarrots Jul 28, 2020


		The project comprises:
		This program provides an interface and implementation that third parties can use to create and trade their tokens.


		## Interface

		The on-chain Token Program is written in Rust and available on crates.io as [spl-token](https://docs.rs/spl-token/1.0.2/spl_token/) documents the program's [instruction interface documentation](https://docs.rs/spl-token/1.0.2/spl_token/instruction/enum.TokenInstruction.html)


		[Client side bindings](https://github.com/solana-labs/solana-program-library/blob/master/token/js/client/token.js) are available in Javascript to load a Token Program and issue instructions

		[Javascript bindings](https://github.com/solana-labs/solana-program-library/blob/master/token/js/client/token.js) are available that support loading the Token Program on to a chain and issuing instructions.


		A new token type can be created by initializing a new Mint with the `InitializeMint` instruction. The Mint is used to create or "Mint" new tokens, and these tokens are stored in Accounts. A Mint is associated with each Account, which means that the total supply of a particular token type is equal to the balances of all the associated Accounts.

		A Mint can either be configured with a fixed-supply or not. The total supply of a fixed-supply Mint is determined during initialization and deposited into a provided destination account. A non-fixed-supply Mint also has an owner associated with it who has the authority to create new tokens in the future with the `MintTo` instruction.

Add token docs #158

Add token docs #158

Conversation

jackcmay commented Jul 28, 2020 • edited Loading

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

CriesofCarrots left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

jackcmay commented Jul 28, 2020 •

edited

Loading