-
Notifications
You must be signed in to change notification settings - Fork 2
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
Showing
4 changed files
with
272 additions
and
0 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,35 @@ | ||
| # Contributing | ||
|
|
||
| ## Building & Deploying the Options Program | ||
|
|
||
| First install the Solana dev tools and add them to path. Install Rust and Cargo | ||
|
|
||
| ```bash | ||
| cargo test-bpf # to run integration test | ||
| cargo build-bpf | ||
| solana program deploy target/deploy/solana_options.so | ||
| ``` | ||
|
|
||
| ## Building the NodeJS client | ||
|
|
||
| ```bash | ||
| cd src/client/nodejs | ||
| npm install . | ||
| npm run build | ||
| npm test # to run unit tests | ||
| ``` | ||
|
|
||
| ##### live testing | ||
|
|
||
| The `src/client/nodejs/src/e2etests/tests.js` file has a series of test against the blockchain. | ||
|
|
||
| To run this test first start your validator locally in a seperate window (`solana-test-validator`) then call the `setup.sh` to create accounts for alice and bob and tokens that will be used in the tests. | ||
|
|
||
| Warning: these tests take several minutes to complete | ||
|
|
||
| ```bash | ||
| solana-test-validator & # start validator node running on localhost | ||
| sh src/client/nodejs/src/e2e_live_tests/setup.sh | ||
| cd src/client/nodejs | ||
| npm run livetest | ||
| ``` |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,175 @@ | ||
| # Solana NFT Options | ||
| This is a tool for creating and exercising options contracts for tokens and NFTs on the Solana blockchain. This program is currently running on devnet. | ||
| See https://nftoptions.app | ||
|
|
||
| ### Table of Contents | ||
| [Installation](#installation) | ||
| [examples](#examples) | ||
| [Publishing Contracts](#publish) | ||
| [Motivation](#motivation) | ||
| [Benfits of Options on the Blockchain](#benfits-of-options-on-the-blockchain) | ||
| [Design](#design) | ||
|
|
||
| ## Installation | ||
|
|
||
| npm install sol-options | ||
|
|
||
|
|
||
| ## Examples | ||
|
|
||
| Let's show how you can create a call contract to sell 420 units of SOL token for 69 USDC each expiring 10 minutes from now | ||
|
|
||
| ```Javascript | ||
| import { AccountInfo, Keypair } from "@solana/web3.js"; | ||
| import { Connection, PublicKey} from "@solana/web3.js"; | ||
| import { create_call, create_put, exercise_call, OptionType } from "."; | ||
| import { create_doc_img } from "./doc"; | ||
|
|
||
| const your_private_key = [58,61,83,12,252,164,114,167,16,61,196,241,213,62,111,76,253,145,3,249,205,251,23,52, | ||
| 237,158,140,188,84,202,116,216,78,242,2,9,33,177,53,200,7,221,76,53,149,13,243,125,153,187,239,178,76, | ||
| 197,203,88,218,186,174,108,71,19,254,203] | ||
|
|
||
| // connect to your cluster e.g localhost or devnet | ||
| const connection = new Connection("https://api.devnet.solana.com", 'singleGossip'); | ||
|
|
||
| ``` | ||
|
|
||
| ```Javascript | ||
| // create a call contract contract to sell 420 SOL at a price of 69 USDC each | ||
|
|
||
| // your account | ||
| let creator_acc = Keypair.fromSecretKey(new Uint8Array(your_private_key)) | ||
|
|
||
| // set strikes and expiry | ||
| let strike = 69 | ||
| let expiry = Date.now()/1000 + 600 //expire in 10 mins (600s) | ||
| let multiple = 420 | ||
|
|
||
| // the address or symbol you are selling on this call | ||
| let instrument = "SOL" | ||
| // alternatively you can use the address of the token | ||
| // e.g let instrument = new PublicKey("So11111111111111111111111111111111111111112") | ||
|
|
||
| // the token address or symbol of the token you recieve if the call is exercised | ||
| let strike_instrument = "USDC" | ||
|
|
||
|
|
||
| // the address of your accounts that you will send and receive these instruments. | ||
| // for this example your instrument account must hold 1000000000 SOL that will be used as collateral | ||
| let creator_instrument_acc = new PublicKey("GsnpfUQTFnQBuokhttUajopkEeg4YNgwf7j2SSKhRigJ") | ||
| let creator_strike_instrument_acc = new PublicKey('8Tv1h2eNjhfQJXyNR3Ey8WwoHAF1qZW7s7aNH49oCMBP') | ||
|
|
||
| // create the call | ||
| create_call( | ||
| connection,strike, expiry, multiple, creator_acc, instrument, | ||
| strike_instrument, creator_instrument_acc, creator_strike_instrument_acc | ||
| ).then(([sig, contract])=>{ | ||
| console.log(printed_contract(contract)) | ||
| }) | ||
| ``` | ||
|
|
||
| ```json | ||
| { | ||
| "strike": 69, | ||
| "expiry": 1639040144.763, | ||
| "multiple": 420, | ||
| "instrument": "D3KCKMTY8rgWtVmxKdCeugKEFbJMjSHk7iWiLMAKrrMf", | ||
| "strike_instrument": "6Uhbk6FwCLLQfsKJ8kn8uCsiF5iZNVQDw5QxMNJh9XiJ", | ||
| "nft_id": "4q3E9ZxG6VFhQUL45AC3qmVpv1aEzr5dXRUo1h9Ceqaj", | ||
| "nft_account": "HyhK3xraTRGXPbwow5PY7Z7yhMTQuPDme13rdngYFQfU", | ||
| "account_id": "7dsBkXTW1cdmN6bFENampDLkQsk63TZimsduUwCB8aWr", | ||
| "collateral_acc": "GGDmFyQbHRSxpL8AikpLSArQc9EA5CJNvwkALohCJ5An", | ||
| "writer_recv_acc": "GsnpfUQTFnQBuokhttUajopkEeg4YNgwf7j2SSKhRigJ", | ||
| "writer": "6KAqLqtYj5d31Am1pQDYqPSUWyKFkqh3q7iayNvmUMox", | ||
| "kind": "call" | ||
| } | ||
| ``` | ||
|
|
||
| ## Publish | ||
|
|
||
| You can create an image for your contract too and publish it to http://nftoptions.app | ||
|
|
||
| ```Javascript | ||
| create_call( | ||
| connection,strike, expiry, multiple, creator_acc, instrument, | ||
| strike_instrument, creator_instrument_acc, creator_strike_instrument_acc | ||
| ).then(([sig, contract])=>{ | ||
| console.log(printed_contract(contract)) | ||
| create_doc_img(contract, (err, img, cb)=>{ | ||
| img.write("example.png"); | ||
| await publish_doc(contract) | ||
| }) | ||
| }) | ||
| ``` | ||
|
|
||
| `example.png` | ||
|
|
||
|  | ||
|
|
||
| ## Motivation | ||
|
|
||
| ### What are options? | ||
| The style of options in are almost identical to American Options traded on the stock market. Options are useful tools for limiting risk and can allow those will little capital more access to transactions that otherwise would have been difficult. | ||
|
|
||
| Let look at an example. Suppose Alice has a house she bought for $800,000. Say she is interested in moving and would be happy to sell it at $1 million in the next 3 months. Bob is looking to buy houses in area. He does some research and is confident that the housing prices will rise in the next 3 months. He sees alice's house and based on his research, it will have a value of $1.5 million in the next 3 months. For Bob, getting the house at $1 million is a good deal but he doesn't have the $1 million lying around to make the purchase. Alice can write an options contract that gives Bob the right to buy the house at $1 million over the next 3 months, and sell it to him for a premium (lets say $25,000). That way, if Bob still doesn't find the money in 3 months Alice can pocket the $25,000. Bob buys the contract for $25,000 and buys himself some time to find the $1 million. Two months later, it turns out Bob was right and the price skyrockets to $2 million. Bob's contract is now worth $1 million because he can buy the house for $1 million and and sell it $2 million. For a small $25,000 investment Bob has made a lot of profit. If Bob still likes he can look for the $1 million to purchase the home (excercise the contract) or he can sell the contract to someone else who has the money to buy the home. So essentially, options allow you to trade the rights to ownership of an asset at a defined prices and period of time. | ||
|
|
||
| You can learn more about option here | ||
|
|
||
| ### Options on the Blockchain | ||
| In our example we looked at real estate options. The same thing can be done with tokens on the blockchain. The cool thing about the blockchain, and fungible and non-fungible tokens, is that you can thingify any asset and represent is a token. In our example above , Alice could digitally make her contract by minting an NFT for her house placing the contract on the blockchain. This package allows you to do that very easily. | ||
|
|
||
| ## Benfits of Options on the Blockchain | ||
| For those familiar with options on the stock market, options on Solana blockchain are a superset of stock market options with several key advantages | ||
| 1. Transfers are direct. There are no brokers in between who make profit through arbitrage. The blockchain makes this trivial and protects holders from situations such as the Gamestop Fiaso e.t.c | ||
| 2. You can only transfer assets you actually own. There are no naked options (option on assets not owned) that are prevelant on the stock market and add a lot of risk to the system. | ||
| 3. Transparency. It very easy to verify ownership of tokens, NFTs and cryto assets. | ||
| 4. More classes of assets. NFTs and tokens allow you to represent a broad range of assets in the digital universe. It's trivial to write contracts on one-of-a-kind assets through NFTs. | ||
| Because the progam lives in an isolted runtime on the Blockchain, it is unaware of asset prices in fiat currency or otherwise, it is there recomended that the buyer checks asset prices before attempting to excercise. | ||
|
|
||
|
|
||
| ## Design | ||
| The options program is a rust program that lives on the Solana Blockchain. It acts as an authority and escrow for options. It verifies that the create of the option has the assets they claim and transfers them escrow. In for each contract created, an NFT is minted by the progam to mark ownership of the contract. This NFT is gifted to the contract creator. To sell the contract, the creator sells this NFT to the contract buyer. When a buyer attempts to excercise a contract, the program verifies that the buyer owns the NFT. | ||
|
|
||
| There are two main classes of options: | ||
| * Options on existing tokens/cryptocurrencies | ||
| * Options on new NFT (one-of-a-kind) assets | ||
|
|
||
|
|
||
| ### Options on existing tokens/cryptocurrencies | ||
|
|
||
| For existing tokens, the creator first ensures that they have accounts associated with the tokens. They then send the addresses of the tokens and accounts to options program along with details specifying the contract type (call or put), strike , multiple and the instruction code for creating an option. Additionally, the NodeJS client creates an empty account that it sends along with the creator’s details. It also creates an options program account that will be used to hold the contract details. Additionally, it also creates an address for an NFT that will be minted by the program. | ||
| Note that to have accounts live on the blockchain some rent it paid. You can learn about Solana rent [here](). In our design, generally the creator pays the rent for accounts that are created. | ||
|
|
||
| Once the options program receives the accounts and details from the program it reads the instruction code and begins the create contract instruction. In Solana code in the program is atomic. That means it will either completely pass or completely fail. In other words, if an error occurs in the program, it would be as if it didn’t run at all. | ||
|
|
||
| In the create instruction, the first step of the program is to transfer the collateral from the creators account to the collateral. For example, if this is for a call to 100 (the multiple) units of SOL for 1000 (the strike) units of USDC each, the program would transfer 100 SOL to from the creators account to the collateral account. It will then take ownership of the collateral account. | ||
|
|
||
| Next, the options program mints an NFT that it uses to signify ownership of the contract. For clarity, we will call this the Ownership-NFT. The NFT is minted and frozen by the program to the address that creator. Only owners of this token can exercise the contract. To sell this contract, the creator issues this NFT to the buyer. By checking the details of the options account, the buyer can confirm that the ownership token matches the contract. | ||
| Next the options program saves the contract details (the state) into the options program account. Importantly, this state keeps the details of the address of the account where the creator will receive his strike instrument token (in the case of a call) or instrument token ( in the case of a put) at exercise. In our example above, this will be the address where he will receive 1000 * 100 USDC for his 100 SOL in collateral. | ||
|
|
||
|  | ||
|
|
||
| To Exercise the contract, the buyer of the contract proves ownership by presenting the ownership NFT that he bought from the seller. Along with the details about the contracts and the accounts he will be using to exchange tokens for the the collateral. In our example above, the buyer will submit an account where he will send the USDC from and another account where he will receive the 100 SOL for the collateral. | ||
|
|
||
| The options program first verifies ownership via burning the NFT token. It then checks the details of the contract and finally makes the transfer if the contract hasn't expired. Because there is no easy and trusted way to get asset prices off the chain, buyers must take caution to ensure that the contracts they exercise are indeed in the money; the program will not enforce this. Once exercised, the program deletes its account and returns any rent or fees used to back to the creator of the contract. | ||
|
|
||
| For contracts that have expired, the creator of the contract makes an explicit "close" instruction to program to return back collateral, any rent, and delete the program account. This instruction will only execute if it is issued by the creator and if the contract is expired. The program uses the unix timestamp to determine whether the contract is expired or not. | ||
|  | ||
|
|
||
| ### Options on new NFTs (one-of-a-kind assets) | ||
|
|
||
| In the example above, we looked at an options contract for exchanging USDC and SOL. However, in many case a person may want to trade an item that has no existing token, or one item that is hard appraise in an existing token. For example, one may want to write an options contract on their house or peice of art. The blockchain makes this very easy to do by minting NFTs (non-fungible-tokens) for such items. | ||
|
|
||
| The options program has an optional "step 0" create NFT mint instruction where the creator can ask the program to mint an NFT for the instrument they want to write an option. For example, if Alice wants to create a call contract that gives Bob the write to buy her house for $69,420, she can call this create NFT instruction to mint an NFT for her house, the program will then store this NFT and only release it to Bob once he pays the $69,420 USDC | ||
|
|
||
|  | ||
|
|
||
| ## Conclusion | ||
|
|
||
| Thank you so much for using this package. If you would like to contribute, or have suggestions, or questions, feel free to drop a PR or github issue. Visit https://nftoptions.app to see some of the existing contracts. Join the discord for more updates https://discord.gg/AHtHnZY8. | ||
|
|
||
| ## Resources & Credits | ||
| * Paul Schaaf has a great tutorial for writing contracts on Solana https://paulx.dev/blog/2021/01/14/programming-on-solana-an-introduction/ | ||
| * MIT's book on Rust http://web.mit.edu/rust-lang_v1.25/arch/amd64_ubuntu1404/share/doc/rust/html/book/index.html | ||
| * The Solana Docs https://docs.solana.com/ | ||
| * Solana Program Library https://github.com/solana-labs/solana-program-library/ |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,51 @@ | ||
| { | ||
| "name": "solana-options", | ||
| "version": "1.0.0", | ||
| "description": "Minting of options contract NFT on the Solana blockchain", | ||
| "main": "build/index.js", | ||
| "scripts": { | ||
| "build": "tsc -p tsconfig.json", | ||
| "test": "tsc -p tsconfig.json; mocha build/test.js ", | ||
| "livetest": "tsc -p tsconfig.json; mocha build/e2e_live_tests/tests.js " | ||
| }, | ||
| "repository": { | ||
| "type": "git", | ||
| "url": "git+https://github.com/dbanda/solana-options.git" | ||
| }, | ||
| "keywords": [ | ||
| "NFT", | ||
| "Solana", | ||
| "Options", | ||
| "Trading", | ||
| "Contracts" | ||
| ], | ||
| "author": "Dalitso Banda <dalitsohb@gmail.com>", | ||
| "license": "ISC", | ||
| "bugs": { | ||
| "url": "https://github.com/dbanda/solana-options/issues" | ||
| }, | ||
| "homepage": "https://github.com/dbanda/solana-options#readme", | ||
| "devDependencies": { | ||
| "@types/chai": "^4.3.0", | ||
| "@types/mocha": "^9.0.0", | ||
| "@types/rewire": "^2.5.28", | ||
| "@types/sinon": "^10.0.6", | ||
| "chai": "^4.3.4", | ||
| "mocha": "^9.1.3", | ||
| "rewire": "^5.0.0", | ||
| "sinon": "^12.0.1" | ||
| }, | ||
| "dependencies": { | ||
| "@solana/spl-token": "^0.1.8", | ||
| "@solana/web3.js": "^1.31.0", | ||
| "@react-pdf/renderer": "^2.0.21", | ||
| "@solana/spl-token-registry": "^0.2.488", | ||
| "axios": "^0.24.0", | ||
| "borsh": "^0.6.0", | ||
| "dayjs": "^1.10.7", | ||
| "easyqrcodejs-nodejs": "^4.4.0", | ||
| "jimp": "^0.16.1", | ||
| "qrcode-with-logos": "^1.0.3", | ||
| "bn.js": "^5.2.0" | ||
| } | ||
| } |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,11 @@ | ||
| { | ||
| "compilerOptions": { | ||
| "module": "commonjs", | ||
| "outDir": "./build", | ||
| "allowJs": true, | ||
| "target": "es2017", | ||
| "esModuleInterop": true, | ||
| "moduleResolution": "node" | ||
| }, | ||
| "include": ["src/**/*.ts"] | ||
| } |