define token interfaces

Author: alexytsu

Cargo.toml

@@ -1,5 +1,6 @@
 [workspace]
 
 members = [
-  "fvm_dispatch"
+  "fvm_dispatch",
+  "fil_token",
 ]

fil_token/Cargo.toml

@@ -0,0 +1,9 @@
+[package]
+name = "fil_token"
+version = "0.1.0"
+edition = "2021"
+
+# See more keys and their definitions at https://doc.rust-lang.org/cargo/reference/manifest.html
+
+[dependencies]
+fvm_shared = { version = "0.8.0" }

fil_token/src/lib.rs

@@ -0,0 +1,4 @@
+pub mod token;
+
+#[cfg(test)]
+mod tests {}

fil_token/src/token/mod.rs

@@ -0,0 +1,30 @@
+pub mod receiver;
+
+use fvm_shared::address::Address;
+pub use fvm_shared::econ::TokenAmount;
+
+pub type Result<T> = std::result::Result<T, TokenError>;
+pub enum TokenError {}
+
+/// A standard fungible token interface allowing for on-chain transactions
+pub trait Token {
+    fn name() -> String;
+
+    fn symbol() -> String;
+
+    fn total_supply() -> TokenAmount;
+
+    fn balance_of(holder: Address) -> Result<TokenAmount>;
+
+    fn increase_allowance(spender: Address, value: TokenAmount) -> Result<TokenAmount>;
+
+    fn decrease_allowance(spender: Address, value: TokenAmount) -> Result<TokenAmount>;
+
+    fn revoke_allowance(spender: Address) -> Result<()>;
+
+    fn allowance(owner: Address, spender: Address) -> Result<TokenAmount>;
+
+    fn burn(amount: TokenAmount, data: &[u8]) -> Result<TokenAmount>;
+
+    fn burn_from(from: Address, amount: TokenAmount, data: &[u8]) -> Result<TokenAmount>;
+}

fil_token/src/token/receiver.rs

@@ -0,0 +1,10 @@
+use fvm_shared::{address::Address, econ::TokenAmount};
+
+pub type Result<T> = std::result::Result<T, ReceiverError>;
+
+pub enum ReceiverError {}
+
+/// Standard interface for a contract that wishes to receive tokens
+pub trait TokenReceiver {
+    fn token_received(from: Address, amount: TokenAmount, data: &[u8]) -> Result<u32>;
+}