Merge pull request #80 from smartcontractkit/link-token-jetton-go-bindings

[NONEVM-2181] Jetton Go bindings

Author: patricios-space

contracts/contracts/examples/jetton/onramp_mock.tolk

@@ -48,13 +48,13 @@ fun OnrampMock.handleJettonTransferNotification(
 
     // Handle the jetton transfer
     if (msg.jettonAmount < FEE) {
-        emit(JETTON_TOPIC, InsufficientFee { queryId: msg.queryId, sender: sender });
+        emit(JETTON_TOPIC, InsufficientFee { queryId: msg.queryId, sender: msg.transferInitiator });
     } else {
         emit(
             JETTON_TOPIC,
             AcceptedRequest {
                 queryId: msg.queryId,
-                sender: sender,
+                sender: msg.transferInitiator,
                 payload: forwardPayloadCell!,
             }
         );

contracts/contracts/examples/jetton/sender.tolk

@@ -1,5 +1,6 @@
 import "@stdlib/common.tolk"
 import "../../lib/jetton/jetton_client.tolk"
+import "../../lib/jetton/messages.tolk"
 
 // JettonSender contract in Tolk
 // Allows sending jettons to other addresses
@@ -8,14 +9,16 @@ struct JettonSender {
 }
 
 // Send jettons fast message (basic transfer)
-struct (0x6984f9bb) SendJettonsFast {
+// 0x4C169F42 == crc32('SendJettonsFast')
+struct (0x4C169F42) SendJettonsFast {
     queryId: uint64
     amount: coins
     destination: address
 }
 
 // Send jettons extended message (with additional parameters)
-struct (0xe815f1d0) SendJettonsExtended {
+// 0x7FDA8110 == crc32('SendJettonsExtended')
+struct (0x7FDA8110) SendJettonsExtended {
     queryId: uint64
     amount: coins
     destination: address
@@ -24,7 +27,7 @@ struct (0xe815f1d0) SendJettonsExtended {
     forwardPayload: cell
 }
 
-type IncomingMessage = SendJettonsFast | SendJettonsExtended
+type IncomingMessage = SendJettonsFast | SendJettonsExtended | ReturnExcessesBack
 
 fun JettonSender.load(): JettonSender {
     return JettonSender.fromCell(contract.getData());
@@ -77,5 +80,9 @@ fun onInternalMessage(in: InMessage) {
         SendJettonsExtended => {
             this.sendJettonsExtended(msg);
         }
+        ReturnExcessesBack => {
+            // Accept excess ton
+            return;
+        }
     }
 }

contracts/contracts/examples/jetton/simple_receiver.tolk

@@ -1,6 +1,7 @@
 import "@stdlib/common.tolk"
 import "../../lib/jetton/jetton_client.tolk"
 import "../../lib/jetton/messages.tolk"
+import "../../lib/utils"
 
 // SimpleJettonReceiver contract in Tolk
 // Simple receiver that just tracks amounts and payloads
@@ -23,23 +24,22 @@ fun SimpleJettonReceiver.store(self) {
 type IncomingMessage = TransferNotificationForRecipient
 
 fun onInternalMessage(in: InMessage) {
-    if (in.body.isEmpty()) {
-        // ignore all empty messages
-        return;
-    }
-
-    val msg = IncomingMessage.fromSlice(in.body);
+    val msg = lazy IncomingMessage.fromSlice(in.body);
 
     var this = SimpleJettonReceiver.load();
 
     match (msg) {
         TransferNotificationForRecipient => {
             this.handleJettonTransferNotification(msg, in.senderAddress);
         }
+        else => {
+            // ignore empty messages, "wrong opcode" for others  
+            assert (in.body.isEmpty()) throw 0xFFFF;
+        }
     }
 }
 
-fun JettonReceiver.handleJettonTransferNotification(
+fun SimpleJettonReceiver.handleJettonTransferNotification(
     mutate self,
     msg: TransferNotificationForRecipient,
     sender: address,
@@ -50,6 +50,7 @@ fun JettonReceiver.handleJettonTransferNotification(
     // Handle the jetton transfer - simple implementation just updates trackers
     self.amountChecker += msg.jettonAmount;
     self.payloadChecker = loadMaybeForwardPayloadAsCell(msg.forwardPayload);
+    self.store();
 }
 
 get fun amountChecker(): coins {

contracts/wrappers/examples/jetton/JettonSender.ts

@@ -9,6 +9,7 @@ import {
   SendMode,
 } from '@ton/core'
 import { JettonClientConfig, jettonClientConfigToCell, JettonOpcodes } from './types'
+import { crc32 } from 'zlib'
 
 export type JettonSenderConfig = {
   jettonClient: JettonClientConfig
@@ -19,8 +20,8 @@ export function jettonSenderConfigToCell(config: JettonSenderConfig): Cell {
 }
 
 export const SenderOpcodes = {
-  SEND_JETTONS_FAST: JettonOpcodes.SEND_JETTONS_FAST,
-  SEND_JETTONS_EXTENDED: JettonOpcodes.SEND_JETTONS_EXTENDED,
+  SEND_JETTONS_FAST: crc32('SendJettonsFast'),
+  SEND_JETTONS_EXTENDED: crc32('SendJettonsExtended'),
 }
 
 export type SendJettonsFastMessage = {

contracts/wrappers/examples/jetton/types.ts

@@ -30,10 +30,6 @@ export const JettonOpcodes = {
   CHANGE_METADATA_URL: 0xcb862902,
   UPGRADE: 0x2508d66a,
   // TOP_UP: 0x8,
-
-  // Custom contract opcodes
-  SEND_JETTONS_FAST: 0x6984f9bb,
-  SEND_JETTONS_EXTENDED: 0xe815f1d0,
 }
 
 export const ErrorCodes = {

docs/contracts/overview/jetton/jetton.md

@@ -1,5 +1,7 @@
 # Jettons - TON Tokens
 
+Jettons is the TON standard for Fungible Tokens.
+
 ## Basic workflow
 
 ![Flow diagram](./simple-transfer.png)
@@ -34,9 +36,33 @@ sequenceDiagram
     end
 ```
 
-## Onramp Mock
+## Usage
+
+The [func implementation of Jettons](https://github.com/ton-blockchain/jetton-contract/tree/3d24b419f2ce49c09abf6b8703998187fe358ec9/contracts) is made available throguh nix.
+The minter and wallet contracts can be built by running
+
+```bash
+nix build .#contracts-jetton-func
+```
+
+appending `--print-out-paths` at the end displays the directory where they can be located.
 
-Implements a mock of an Onramp implementation that receives the instruction as the forwardPayload and operates if it covers the fee.
+```bash
+$ nix build .#contracts-jetton-func --print-out-paths
+/nix/store/s3rsxlqskan6ripf2sii9njrzv1mhbxz-contracts-jetton-func-1.2.0
+```
+
+Furthermore, the `#contracts` nix shell compiles and exposes the build directory through the environment variable `PATH_CONTRACTS_JETTON`.
+
+```bash
+$ nix develop .#contracts -c ls -lca $PATH_CONTRACTS_JETTON
+Jetton contracts located here: /nix/store/s3rsxlqskan6ripf2sii9njrzv1mhbxz-contracts-jetton-func-1.2.0/lib/node_modules/jetton/build/
+total 16
+dr-xr-xr-x  6 root wheel  192 Jul  8 14:47 .
+dr-xr-xr-x 15 root wheel  480 Jul  8 14:47 ..
+-r--r--r--  1 root wheel 2386 Jul  8 14:47 JettonMinter.compiled.json
+-r--r--r--  1 root wheel 1834 Jul  8 14:47 JettonWallet.compiled.json
+```
 
 ## Docs
 

flake.nix

@@ -38,7 +38,11 @@
       # Output a set of dev environments (shells)
       devShells =
         {
-          default = pkgs.callPackage ./shell.nix {inherit pkgs;};
+          default = pkgs.callPackage ./shell.nix {
+            inherit pkgs;
+            chainlink-ton = chainlink-ton;
+            jetton-contracts = contracts.packages.contracts-jetton-func;
+          };
           # Development shell for dependency analyzer
           dependency-analyzer = pkgs.callPackage ./tools/dependency_analyzer/shell.nix {inherit pkgs;};
         }

integration-tests/default.nix

@@ -2,10 +2,17 @@
   pkgs,
   rev,
 }: let
-  # Any integration-test specific configuration
+  # Import contracts to get jetton-contracts
+  contracts = pkgs.callPackage ../contracts {inherit pkgs rev;};
+  # Import chainlink-ton package
+  chainlink-ton = pkgs.callPackage ../cmd/chainlink-ton {inherit pkgs rev;};
 in {
   devShells = {
-    ccip-e2e = pkgs.callPackage ./shell-ccip-e2e.nix {inherit pkgs;};
+    ccip-e2e = pkgs.callPackage ./shell-ccip-e2e.nix {
+      inherit pkgs;
+      chainlink-ton = chainlink-ton;
+      jetton-contracts = contracts.packages.contracts-jetton-func;
+    };
     # Note: other integration test environments could go here
   };