Fiona Roy

Portfolio

Welcome to my technical writing portfolio.

I'm a documentation specialist with over 15 years of experience specializing in Cloud, Fintech, and Blockchain. My expertise lies in creating developer-focused content that simplifies obscure technical information. I also enjoy planning information architecture and leading training sessions in documentation best practices.

Please explore my work and feel free to reach out if you have any questions.


API Docs: Amazon SQS

You can be notified of incoming transactions and other asynchronous events. For this we use a notification mechanism that allows you to specify a webhook URL or your own Amazon SQS queue to register for specific types of events.

This section details the required steps to set up a connection with Amazon SQS queues.

API Docs: Fetch Recall Decision

Both inbound and outbound recalls are represented in the Form3 API by the Payment Recall resource, which is a child resource of the Payment resource the recall is for. The Recall Submission or Recall Admission resources are children of the Recall resource and indicate if a recall is inbound (Admission) or outbound (Submission).

Tutorial: Payment Exception Handling

Sending and receiving payments with the Form3 Payments API is quick and simple, but sometimes a payment submission fails. When this happens, the API provides an error message to help identify the cause.

This tutorial looks at common errors that can occur during a payment submission and explains how to diagnose them.

Tutorial: Listening to smart contract events with ethers.js

Ethers.js is a compact JavaScript library that enables developers to interact with the Ethereum blockchain. It serves as a toolkit for building decentralized applications on EVM-compatible blockchain networks.

This guide walks you through the steps to listen to smart contract events via ethers.js, covering the installation and configuration of the tools and technologies required.

Overview: Perpetual contracts

Perpetual contracts, pioneered by Bitmex within the cryptocurrency space, have become one of the most popular derivative products. They allow traders to speculate on the future price of an asset by going long (buying) or going short (selling) perpetual futures contracts. Unlike traditional futures contracts, perpetual contracts don't have an expiration date and remain effective until the trader closes their position.

Perpetual contracts allow traders to speculate on the future price of a given asset by buying (going long) or selling (going short). Unlike typical futures contracts, perpetuals do not expire and instead remain effective until the trader closes their position.

Overview: DEX aggregator

Entropic protocol delivers a sophisticated cross-ledger DEX aggregator. It enables optimal execution through market aggregation. By tapping into Automated Market Makers (AMMs) across multiple chains, it achieves a dark pool-like execution of orders. This means users can seamlessly initiate a swap of any supported token, then the protocol finds the best route for that swap, whether it's a simple AMM swap or a more complex movement of tokens across different networks to achieve the best outcome.

Overview: Order Book

The Order Book collects groups of requests which are waiting to be processed. It does this at intervals of 5-10 seconds. Subsequently, it employs an algorithm to determine optimal routes for each request, optimizing the overall transaction efficiency.

After receiving a response from the algorithm, the Order Book also sorts requests for any possible *batch* transactions. The Order Book seeks to batch requests, e.g., into the same tokens on the same chain. If possible batches are found, the `Order Manager` sends them to the `Order Executer` for processing.

Guide: Request signing

HTTP request signing is the process of cryptographically signing requests sent to the Form3 API to increase security and ensure access to the API is restricted to entities that have access to a secret private key. Form3 supports request signing as its default authentication method for all supported HTTP method types, including GET, POST, PATCH, DELETE and PUT.