1.4.27 • Published 1 year ago

@optifi/optifi-sdk v1.4.27

Weekly downloads
-
License
Apache-2.0
Repository
github
Last release
1 year ago

OptiFi SDK

TypeScript interfaces for working with the on-chain OptiFi system

Configuration

Configuration variables can be specified either through environment variables, or provided to initializeContext at runtime

Optional Environment Variables:

  • OPTIFI_WALLET: the filepath of a Solana wallet
  • OPTIFI_PROGRAM_ID: The ID of the on chain OptiFi program to interact with. If you don't want to deploy the OptiFi program by yourself, try using the program id deployed on devnet: DeVoPfWrDn2UTA1MbSfagvpQxA91MpNFQnhHRw19dK34

How to initialize a new OptiFi Exchange

  • bootstrap a new exchange(do only once)
npx ts-node scripts/bootstrap.ts

it will create a new exchange with the OPTIFI_EXCHANGE_ID set in ./constants.ts, (if the exchange id is already bootstrapped, just try using another id), also create OptiFi markets that users can trade on. Each OptiFi market will list one tradable instrument and using a seperate Serum orderbook for placing orders.

  • load the exchange info npx ts-node scripts/loadExchange.ts

How to trade

  • create user account on the exchange
npx ts-node scripts/user/createUserAccountIfNotExists.ts
  • deposit fund (OptiFi USDC) to user's margin account (3000 usdc by default)
npx ts-node scripts/user/deposit.ts
  • find all available markets and select an OptiFi market to trade
npx ts-node scripts/findOptifiMarkets.ts

it will print all the market info, find the address of any OptiFi market.

Copy the OptiFi market address you want to trade and paste it to variable market in scripts/constants.ts. It will be imported and used in the scripts of later steps

  • init the user on the OptiFi market (only for first time)
npx ts-node scripts/user/initUserOnMarket.ts

It basically creates an open orders accounts for the Serum orderbook which is used the OptiFi market. Each user will have one open orders accounts for one OptiFi market.

  • check the current orderbook data
npx ts-node scripts/loadMarketOrderbook.ts
  • place ask/bid orders
npx ts-node scripts/order/placeOrder.ts
  • check the user's open account again after new order placed
npx ts-node scripts/loadOpenOdersAccount.ts
  • check the orderbook again after new order placed
npx ts-node scripts/loadMarketOrderbook.ts

How to run AMMs

  • create an AMM
npx ts-node scripts/amm/initializeAMMs.ts

It will create two AMMs, one for trading BTC options, another for trading ETH options

  • to get the info of created BTC/ETH AMMs, run:
npx ts-node scripts/amm/findAMMs.ts
  • change the variable ammIndx in scripts/amm/constants.ts, it will be imported and used in later steps. 1 is for BTC amm, 2 for ETH amm

  • to deposit USDC into an AMM, set the amm address and amount to deposit, and run:

npx ts-node scripts/amm/ammDeposit.ts
  • add the optifi markets to an AMM so that it can trade on that market
npx ts-node scripts/amm/addInstrumentToAmm.ts
  • make sure you have done the last two steps for BOTH BTC and ETH AMMs

  • now the amm is ready to work, run the following command to crank the AMM and let the AMM update orders on OptiFi markets contineously:

npx ts-node scripts/amm/crankAMM.ts

After the BTC or ETH AMM starts to run, orders should be placed on all BTC or ETH related OptiFi markets and updated contineously.

Debug

Error: failed to get info about account : FetchError: request to https://api.devnet.solana.com/ failed, reason: read ECONNRESET

Solution: It's because of the busy Solana network. just wait for a while and try again

1.4.24

1 year ago

1.4.23

1 year ago

1.4.26

1 year ago

1.4.25

1 year ago

1.4.27

1 year ago

1.4.25-alpha

1 year ago

1.4.20

2 years ago

1.4.22

2 years ago

1.4.21

2 years ago

1.4.20-alpha

2 years ago

1.4.11

2 years ago

1.4.10

2 years ago

1.4.13

2 years ago

1.4.12

2 years ago

1.4.15

2 years ago

1.4.14

2 years ago

1.4.17

2 years ago

1.4.16

2 years ago

1.4.19

2 years ago

1.4.18

2 years ago

1.4.21-beta

2 years ago

1.4.21-gamma

2 years ago

1.4.21-alpha

2 years ago

1.4.18-beta

2 years ago

1.4.10-beta-2

2 years ago

1.4.19-alpha

2 years ago

1.4.18-alpha

2 years ago

1.4.10-alpha

2 years ago

1.4.10-beta

2 years ago

1.4.21-beta4

2 years ago

1.4.21-beta3

2 years ago

1.4.21-beta2

2 years ago

1.4.6

2 years ago

1.4.5

2 years ago

1.4.4

2 years ago

1.4.3

2 years ago

1.4.2

2 years ago

1.4.1

2 years ago

1.4.0

2 years ago

1.4.9

2 years ago

1.4.8

2 years ago

1.4.7

2 years ago

1.3.85-mango

2 years ago

1.3.90

2 years ago

1.3.93

2 years ago

1.3.94

2 years ago

1.3.91

2 years ago

1.3.92

2 years ago

1.3.95

2 years ago

1.3.86

2 years ago

1.3.87

2 years ago

1.3.85

2 years ago

1.3.88

2 years ago

1.3.89

2 years ago

1.3.34-beta

2 years ago

1.3.79-sol

2 years ago

1.3.50

2 years ago

1.3.53

2 years ago

1.3.73-beta2

2 years ago

1.3.54

2 years ago

1.3.51

2 years ago

1.3.52

2 years ago

1.3.57

2 years ago

1.3.59-beta

2 years ago

1.3.58

2 years ago

1.3.55

2 years ago

1.3.56

2 years ago

1.3.59

2 years ago

1.3.60

2 years ago

1.3.61

2 years ago

1.3.64

2 years ago

1.3.65

2 years ago

1.3.62

2 years ago

1.3.63

2 years ago

1.3.68

2 years ago

1.3.60-alpha

2 years ago

1.3.69

2 years ago

1.3.66

2 years ago

1.3.67

2 years ago

1.3.76-sol-2

2 years ago

1.3.52-beta2

2 years ago

1.3.80-sol

2 years ago

1.3.31

2 years ago

1.3.32

2 years ago

1.3.30

2 years ago

1.3.35

2 years ago

1.3.36

2 years ago

1.3.33

2 years ago

1.3.34

2 years ago

1.3.39

2 years ago

1.3.37

2 years ago

1.3.38

2 years ago

1.3.42

2 years ago

1.3.43

2 years ago

1.3.40

2 years ago

1.3.41

2 years ago

1.3.46

2 years ago

1.3.47

2 years ago

1.3.44

2 years ago

1.3.45

2 years ago

1.3.48

2 years ago

1.3.49

2 years ago

1.3.35-beta-2

2 years ago

1.3.78-sol

2 years ago

1.3.28

2 years ago

1.3.29

2 years ago

1.3.27

2 years ago

1.3.70-beta

2 years ago

1.3.75-sol

2 years ago

1.3.55-beta

2 years ago

1.3.83-sol

2 years ago

1.3.37-beta

2 years ago

1.3.37-beta-2

2 years ago

1.3.37-beta-3

2 years ago

1.3.60-beta

2 years ago

1.3.34-beta-3

2 years ago

1.3.34-beta-2

2 years ago

1.3.76-sol

2 years ago

1.3.55-beta2

2 years ago

1.3.82-sol

2 years ago

1.3.75-alpha

2 years ago

1.3.83-sol-3

2 years ago

1.3.83-sol-2

2 years ago

1.3.52-beta

2 years ago

1.3.35-beta

2 years ago

1.3.73-beta

2 years ago

1.3.54-beta

2 years ago

1.3.71

2 years ago

1.3.72

2 years ago

1.3.70

2 years ago

1.3.75

2 years ago

1.3.76

2 years ago

1.3.73

2 years ago

1.3.74

2 years ago

1.3.79

2 years ago

1.3.77

2 years ago

1.3.78

2 years ago

1.3.81-sol

2 years ago

1.3.82

2 years ago

1.3.80

2 years ago

1.3.81

2 years ago

1.3.84

2 years ago

1.3.73-sol

2 years ago

1.3.9

2 years ago

1.3.8

2 years ago

1.3.10

2 years ago

1.3.13

2 years ago

1.3.14

2 years ago

1.3.11

2 years ago

1.3.12

2 years ago

1.3.17

2 years ago

1.3.18

2 years ago

1.3.15

2 years ago

1.3.16

2 years ago

1.3.19

2 years ago

1.3.20

2 years ago

1.3.21

2 years ago

1.3.24

2 years ago

1.3.25

2 years ago

1.3.22

2 years ago

1.3.23

2 years ago

1.3.26

2 years ago

1.3.7

2 years ago

1.3.6

2 years ago

1.3.5

2 years ago

1.3.3

2 years ago

1.3.2

2 years ago

1.3.1

2 years ago

1.3.0

2 years ago

1.2.0

2 years ago

1.2.8

2 years ago

1.2.7

2 years ago

1.2.6

2 years ago

1.2.5

2 years ago

1.2.4

2 years ago

1.2.3

2 years ago

1.2.2

2 years ago

1.2.1

2 years ago

1.2.12

2 years ago

1.2.13

2 years ago

1.2.10

2 years ago

1.2.11

2 years ago

1.2.16

2 years ago

1.2.17

2 years ago

1.2.14

2 years ago

1.2.15

2 years ago

1.1.1

2 years ago

1.1.0

2 years ago

1.1.9

2 years ago

1.1.8

2 years ago

1.1.7

2 years ago

1.1.6

2 years ago

1.1.5

2 years ago

1.1.4

2 years ago

1.1.3

2 years ago

1.1.2

2 years ago

1.2.9

2 years ago

1.2.18

2 years ago

1.2.19

2 years ago

1.2.20

2 years ago

1.2.23

2 years ago

1.2.24

2 years ago

1.2.21

2 years ago

1.2.22

2 years ago

1.2.25

2 years ago

1.2.26

2 years ago

1.0.77

2 years ago

1.0.76

2 years ago

1.0.79

2 years ago

1.0.78

2 years ago

1.0.80

2 years ago

1.0.84

2 years ago

1.0.83

2 years ago

1.0.82

2 years ago

1.0.81

2 years ago

1.0.88

2 years ago

1.0.87

2 years ago

1.0.86

2 years ago

1.0.85

2 years ago

1.0.89

2 years ago

1.0.91

2 years ago

1.0.90

2 years ago

1.0.95

2 years ago

1.0.94

2 years ago

1.0.93

2 years ago

1.0.92

2 years ago

1.0.99

2 years ago

1.0.98

2 years ago

1.0.97

2 years ago

1.0.96

2 years ago

1.0.28-a

2 years ago

1.0.62

2 years ago

1.0.61

2 years ago

1.0.60

2 years ago

1.0.22

2 years ago

1.0.65

2 years ago

1.0.21

2 years ago

1.0.64

2 years ago

1.0.63

2 years ago

1.0.26

2 years ago

1.0.69

2 years ago

1.0.25

2 years ago

1.0.68

2 years ago

1.0.24

2 years ago

1.0.67

2 years ago

1.0.23

2 years ago

1.0.28

2 years ago

1.0.27

2 years ago

1.0.34-a

2 years ago

1.0.73

2 years ago

1.0.72

2 years ago

1.0.71

2 years ago

1.0.70

2 years ago

1.0.33

2 years ago

1.0.32

2 years ago

1.0.75

2 years ago

1.0.31

2 years ago

1.0.74

2 years ago

1.0.30

2 years ago

1.0.37

2 years ago

1.0.35

2 years ago

1.0.34

2 years ago

1.0.40

2 years ago

1.0.44

2 years ago

1.0.43

2 years ago

1.0.42

2 years ago

1.0.41

2 years ago

1.0.48

2 years ago

1.0.47

2 years ago

1.0.46

2 years ago

1.0.45

2 years ago

1.0.49

2 years ago

1.0.33-b

2 years ago

1.0.35-a

2 years ago

1.0.33-a

2 years ago

1.0.51

2 years ago

1.0.55

2 years ago

1.0.54

2 years ago

1.0.53

2 years ago

1.0.52

2 years ago

1.0.59

2 years ago

1.0.58

2 years ago

1.0.57

2 years ago

1.0.56

2 years ago

1.0.20

2 years ago

1.0.19

2 years ago

1.0.18

2 years ago

1.0.17

2 years ago

1.0.16

2 years ago

1.0.15

2 years ago

1.0.14

2 years ago

1.0.13

2 years ago

1.0.12

2 years ago

1.0.11

2 years ago

1.0.10

2 years ago

1.0.9

2 years ago

1.0.8

2 years ago

1.0.7

2 years ago

1.0.6

2 years ago

1.0.5

2 years ago

1.0.4

2 years ago

1.0.3-b

2 years ago

1.0.3-a

2 years ago

1.0.3

2 years ago

1.0.2-b

2 years ago

1.0.2-a

2 years ago

1.0.2

2 years ago

1.0.1-c

2 years ago

1.0.1-b

2 years ago

1.0.1-a

2 years ago

1.0.0

2 years ago