making XTC DIP20 compatible (#45)

Author: Daniel Graczer

candid/piggy-bank.did

@@ -1,17 +1,21 @@
 type TransactionId = nat64;
 
-type MintError = variant {
-    NotSufficientLiquidity;
-};
-
-type MintResult = variant {
-    Ok : TransactionId;
-    Err: MintError;
+type TxError = variant {
+  InsufficientAllowance;
+  InsufficientBalance;
+  ErrorOperationStyle;
+  Unauthorized;
+  LedgerTrap;
+  ErrorTo;
+  Other;
+  BlockUsed;
+  AmountTooSmall;
 };
+type TxReceipt = variant { Ok : nat; Err : TxError };
 
 service : {
     balance: () -> (amount: nat64);
     get_available_cycles: () -> (amount: nat64);
-    perform_mint: (record { canister: principal; account: opt principal; cycles: nat64 }) -> (MintResult);
+    perform_mint: (record { canister: principal; account: opt principal; cycles: nat64 }) -> (TxReceipt);
     whoami : () -> (principal);
 }

candid/xtc.did

@@ -37,14 +37,18 @@ type TxRecord =
    status: TransactionStatus;
  };
 
-type TxReceipt =
- variant {
-   Err: variant {
-          InsufficientAllowance;
-          InsufficientBalance;
-        };
-   Ok: nat;
- };
+type TxError = variant {
+  InsufficientAllowance;
+  InsufficientBalance;
+  ErrorOperationStyle;
+  Unauthorized;
+  LedgerTrap;
+  ErrorTo;
+  Other;
+  BlockUsed;
+  AmountTooSmall;
+};
+type TxReceipt = variant { Ok : nat; Err : TxError };
 
 ////////// END ERC-20 //////////
 
@@ -61,18 +65,6 @@ type BurnResult = variant {
     Err: BurnError;
 };
 
-type TransferError = variant {
-    InsufficientBalance;
-    AmountTooLarge;
-    CallFailed;
-    Unknown;
-};
-
-type TransferResponse = variant {
-    Ok : TransactionId;
-    Err: TransferError;
-};
-
 type MintError = variant {
     NotSufficientLiquidity;
 };
@@ -143,13 +135,6 @@ type EventsConnection = record {
     next_canister_id: opt principal;
 };
 
-type TokenMetaData = record {
-    name    : text;
-    symbol  : text;
-    decimal : nat8;
-    features: vec text;
-};
-
 type Stats = record {
     supply: nat;
     fee: nat;
@@ -183,22 +168,17 @@ service : {
    historySize: () -> (nat) query;
    logo: () -> (text) query;
    nameErc20: () -> (text) query;
+   name: () -> (text) query;
    symbol: () -> (text) query;
    totalSupply: () -> (nat) query;
    transferErc20: (principal, nat) -> (TxReceipt);
+   transfer: (principal, nat) -> (TxReceipt);
    transferFrom: (principal, principal, nat) -> (TxReceipt);
+   mint: (principal, nat) -> (MintResult);
    ////////// END ERC-20 //////////
 
-    // Return all of the meta data of a token.
-    meta : () -> (TokenMetaData) query;
-
-    // Return all of the meta data of a token as an update.
-    meta_certified : () -> (TokenMetaData);
-
-    balance: (opt principal) -> (amount: nat64);
-    transfer: (record { to: principal; amount: nat64 }) -> (TransferResponse);
-    mint: (opt principal) -> (MintResult);
     burn: (record { canister_id: principal; amount: nat64 }) -> (BurnResult);
+    balance: (opt principal) -> (amount: nat64);
 
     // History
     get_transaction : (id: TransactionId) -> (opt Event);
@@ -212,8 +192,6 @@ service : {
 
     // ----------- Cycles wallet compatible API
 
-    name : () -> (opt text) query;
-
     wallet_balance: () -> (record { amount: nat64 }) query;
     wallet_send: (record { canister: principal; amount: nat64 }) -> (ResultSend);
 

piggy-bank/src/lib.rs

@@ -1,4 +1,4 @@
-use ic_kit::candid::CandidType;
+use ic_kit::candid::{CandidType, Nat};
 use ic_kit::macros::*;
 use ic_kit::*;
 use serde::*;
@@ -10,13 +10,23 @@ struct PerformMintArgs {
     cycles: u64,
 }
 
-#[derive(CandidType, Deserialize, Debug)]
-enum MintError {
-    NotSufficientLiquidity,
+#[derive(CandidType, Debug, Deserialize, Eq, PartialEq)]
+pub enum TxError {
+    InsufficientAllowance,
+    InsufficientBalance,
+    ErrorOperationStyle,
+    Unauthorized,
+    LedgerTrap,
+    ErrorTo,
+    Other,
+    BlockUsed,
+    AmountTooSmall,
 }
 
+pub type TxReceipt = Result<Nat, TxError>;
+
 #[update]
-async fn perform_mint(args: PerformMintArgs) -> Result<u64, MintError> {
+async fn perform_mint(args: PerformMintArgs) -> TxReceipt {
     let ic = get_context();
 
     let account = match args.account {
@@ -25,11 +35,11 @@ async fn perform_mint(args: PerformMintArgs) -> Result<u64, MintError> {
     };
 
     if ic.balance() < args.cycles {
-        return Err(MintError::NotSufficientLiquidity);
+        return Err(TxError::InsufficientBalance);
     }
 
     match ic
-        .call_with_payment(args.canister, "mint", (Some(account),), args.cycles)
+        .call_with_payment(args.canister, "mint", (account, Nat::from(0)), args.cycles)
         .await
     {
         Ok((r,)) => r,
@@ -66,8 +76,8 @@ mod tests {
             .with_handler(
                 Method::new()
                     .expect_cycles(300)
-                    .response::<Result<u64, MintError>>(Ok(17))
-                    .expect_arguments((Some(&alice),)),
+                    .response::<TxReceipt>(Ok(Nat::from(17)))
+                    .expect_arguments((alice, Nat::from(0))),
             )
             .inject();
 
@@ -77,18 +87,17 @@ mod tests {
                 account: None,
                 cycles: 300
             })
-            .await
-            .unwrap(),
-            17
+            .await,
+            Ok(Nat::from(17))
         );
 
         MockContext::new()
             .with_caller(alice.clone())
             .with_handler(
                 Method::new()
                     .expect_cycles(140)
-                    .response::<Result<u64, MintError>>(Ok(18))
-                    .expect_arguments((Some(&bob),)),
+                    .response::<TxReceipt>(Ok(Nat::from(18)))
+                    .expect_arguments((bob, Nat::from(0))),
             )
             .inject();
 
@@ -98,9 +107,8 @@ mod tests {
                 account: Some(bob),
                 cycles: 140
             })
-            .await
-            .unwrap(),
-            18
+            .await,
+            Ok(Nat::from(18))
         );
     }