Merge branch 'develop' into poc-fee-in-any-token

.github/workflows/integration-ci.yml

@@ -44,3 +44,21 @@ jobs:
 
       - name: Step 3 - Check correct linting
         run: yarn eslint .
+
+  gas-report:
+    runs-on: ubuntu-latest
+    steps:
+      - name: Check out main branch
+        uses: actions/checkout@v3
+
+      - name: Setup Scarb
+        uses: software-mansion/[email protected]
+
+      - name: Install project
+        run: yarn install --frozen-lockfile
+
+      - name: Start devnet in background
+        run: scarb run start-devnet
+
+      - name: Gas report
+        run: scarb run profile --check

README.md

@@ -15,6 +15,9 @@ As the fee should be larger than the claiming transaction cost, there might be a
 ## Deposits
 
 Deposits follow the flow described in the first 3 steps above.
+
+![Sessions diagram](/docs/deposit_diagram.png)
+
 For more details please see the `deposit` function at [Deposit example](./lib/deposit.ts).
 
 ## Claiming
@@ -25,6 +28,8 @@ Claiming can be done in two ways:
 
 The recipient uses the private key to craft a transaction to claim the gift. The `fee_amount` will be used to cover the transaction fees, so the recipient only gets the `gift_amount`. The recipient doesn’t need to have any funds in their wallet or even a deployed wallet to claim the gift using this method.
 
+![Sessions diagram](/docs/internal_claim.png)
+
 Edge cases:
 
 - Insufficient `fee_amount`: Alternative options are "external claiming", waiting for transaction price to go down, or canceling the gift (see below).
@@ -39,6 +44,8 @@ It is also possible for someone else to pay for the claim fees. This can be usef
 
 The receiver can use the private key sign a message containing the address receiving the address (and optionally some address that will receive the dust). Using this signature, anybody can execute a transaction to perform the claim. To do so, they should call `claim_external` on the escrow account (through the `execute_action` entrypoint).
 
+![Sessions diagram](/docs/external_claim.png)
+
 For more details please see the `claimExternal` function at [Claim External Example](./lib/claim.ts).
 
 ## Cancelling Gifts