Skip to content

Commit

Permalink
Add memo docs (solana-labs#160)
Browse files Browse the repository at this point in the history
* Add memo docs

* nudge
  • Loading branch information
jackcmay authored Jul 28, 2020
1 parent 0f2226c commit a02c403
Show file tree
Hide file tree
Showing 3 changed files with 31 additions and 6 deletions.
27 changes: 25 additions & 2 deletions docs/src/memo.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,5 +2,28 @@
title: Memo Program
---

A simple program that accepts a string of encoded characters and verifies that
it parses. Currently handles UTF-8.
A simple program that validates a string of UTF-8 encoded characters. It can be
used to record a string on-chain, stored in the instruction data of a successful
transaction.

## Background

Solana's programming model and the definitions of the Solana terms used in this
document are available at:
- https://docs.solana.com/apps
- https://docs.solana.com/terminology

## Source

The Memo Program's source is available on
[github](https://github.com/solana-labs/solana-program-library)

## Interface

The on-chain Memo Program is written in Rust and available on crates.io as
[spl-memo](https://crates.io/crates/spl-memo).

## Operational overview

The Memo program attempts to UTF-8 decode the instruction data; if successfully
decoded, the instruction is successful.
3 changes: 1 addition & 2 deletions docs/src/token.md
Original file line number Diff line number Diff line change
Expand Up @@ -22,8 +22,7 @@ The Token Program's source is available on
## 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/). The program's
[instruction interface]
[spl-token](https://docs.rs/spl-token). The program's [instruction interface
documentation](https://docs.rs/spl-token/1.0.2/spl_token/instruction/enum.TokenInstruction.html)
can also be found there.

Expand Down
7 changes: 5 additions & 2 deletions memo/README.md
Original file line number Diff line number Diff line change
@@ -1,4 +1,7 @@
# Memo Program

A simple program that accepts a string of encoded characters and verifies that
it parses. Currently handles UTF-8.
A simple program that validates a string of UTF-8 encoded characters. It can be
used to record a string on-chain, stored in the instruction data of a successful
transaction.

Full documentation is available at https://spl.solana.com

0 comments on commit a02c403

Please sign in to comment.