1.4.27 • Published 3 years ago

@optifi/optifi-sdk v1.4.27

Weekly downloads
-
License
Apache-2.0
Repository
github
Last release
3 years 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

3 years ago

1.4.23

3 years ago

1.4.26

3 years ago

1.4.25

3 years ago

1.4.27

3 years ago

1.4.25-alpha

3 years ago

1.4.20

3 years ago

1.4.22

3 years ago

1.4.21

3 years ago

1.4.20-alpha

3 years ago

1.4.11

3 years ago

1.4.10

3 years ago

1.4.13

3 years ago

1.4.12

3 years ago

1.4.15

3 years ago

1.4.14

3 years ago

1.4.17

3 years ago

1.4.16

3 years ago

1.4.19

3 years ago

1.4.18

3 years ago

1.4.21-beta

3 years ago

1.4.21-gamma

3 years ago

1.4.21-alpha

3 years ago

1.4.18-beta

3 years ago

1.4.10-beta-2

3 years ago

1.4.19-alpha

3 years ago

1.4.18-alpha

3 years ago

1.4.10-alpha

3 years ago

1.4.10-beta

3 years ago

1.4.21-beta4

3 years ago

1.4.21-beta3

3 years ago

1.4.21-beta2

3 years ago

1.4.6

3 years ago

1.4.5

3 years ago

1.4.4

3 years ago

1.4.3

3 years ago

1.4.2

3 years ago

1.4.1

3 years ago

1.4.0

3 years ago

1.4.9

3 years ago

1.4.8

3 years ago

1.4.7

3 years ago

1.3.85-mango

3 years ago

1.3.90

3 years ago

1.3.93

3 years ago

1.3.94

3 years ago

1.3.91

3 years ago

1.3.92

3 years ago

1.3.95

3 years ago

1.3.86

3 years ago

1.3.87

3 years ago

1.3.85

3 years ago

1.3.88

3 years ago

1.3.89

3 years ago

1.3.34-beta

3 years ago

1.3.79-sol

3 years ago

1.3.50

3 years ago

1.3.53

3 years ago

1.3.73-beta2

3 years ago

1.3.54

3 years ago

1.3.51

3 years ago

1.3.52

3 years ago

1.3.57

3 years ago

1.3.59-beta

3 years ago

1.3.58

3 years ago

1.3.55

3 years ago

1.3.56

3 years ago

1.3.59

3 years ago

1.3.60

3 years ago

1.3.61

3 years ago

1.3.64

3 years ago

1.3.65

3 years ago

1.3.62

3 years ago

1.3.63

3 years ago

1.3.68

3 years ago

1.3.60-alpha

3 years ago

1.3.69

3 years ago

1.3.66

3 years ago

1.3.67

3 years ago

1.3.76-sol-2

3 years ago

1.3.52-beta2

3 years ago

1.3.80-sol

3 years ago

1.3.31

3 years ago

1.3.32

3 years ago

1.3.30

3 years ago

1.3.35

3 years ago

1.3.36

3 years ago

1.3.33

3 years ago

1.3.34

3 years ago

1.3.39

3 years ago

1.3.37

3 years ago

1.3.38

3 years ago

1.3.42

3 years ago

1.3.43

3 years ago

1.3.40

3 years ago

1.3.41

3 years ago

1.3.46

3 years ago

1.3.47

3 years ago

1.3.44

3 years ago

1.3.45

3 years ago

1.3.48

3 years ago

1.3.49

3 years ago

1.3.35-beta-2

3 years ago

1.3.78-sol

3 years ago

1.3.28

3 years ago

1.3.29

3 years ago

1.3.27

3 years ago

1.3.70-beta

3 years ago

1.3.75-sol

3 years ago

1.3.55-beta

3 years ago

1.3.83-sol

3 years ago

1.3.37-beta

3 years ago

1.3.37-beta-2

3 years ago

1.3.37-beta-3

3 years ago

1.3.60-beta

3 years ago

1.3.34-beta-3

3 years ago

1.3.34-beta-2

3 years ago

1.3.76-sol

3 years ago

1.3.55-beta2

3 years ago

1.3.82-sol

3 years ago

1.3.75-alpha

3 years ago

1.3.83-sol-3

3 years ago

1.3.83-sol-2

3 years ago

1.3.52-beta

3 years ago

1.3.35-beta

3 years ago

1.3.73-beta

3 years ago

1.3.54-beta

3 years ago

1.3.71

3 years ago

1.3.72

3 years ago

1.3.70

3 years ago

1.3.75

3 years ago

1.3.76

3 years ago

1.3.73

3 years ago

1.3.74

3 years ago

1.3.79

3 years ago

1.3.77

3 years ago

1.3.78

3 years ago

1.3.81-sol

3 years ago

1.3.82

3 years ago

1.3.80

3 years ago

1.3.81

3 years ago

1.3.84

3 years ago

1.3.73-sol

3 years ago

1.3.9

3 years ago

1.3.8

3 years ago

1.3.10

3 years ago

1.3.13

3 years ago

1.3.14

3 years ago

1.3.11

3 years ago

1.3.12

3 years ago

1.3.17

3 years ago

1.3.18

3 years ago

1.3.15

3 years ago

1.3.16

3 years ago

1.3.19

3 years ago

1.3.20

3 years ago

1.3.21

3 years ago

1.3.24

3 years ago

1.3.25

3 years ago

1.3.22

3 years ago

1.3.23

3 years ago

1.3.26

3 years ago

1.3.7

3 years ago

1.3.6

3 years ago

1.3.5

3 years ago

1.3.3

3 years ago

1.3.2

3 years ago

1.3.1

3 years ago

1.3.0

3 years ago

1.2.0

3 years ago

1.2.8

3 years ago

1.2.7

3 years ago

1.2.6

3 years ago

1.2.5

3 years ago

1.2.4

3 years ago

1.2.3

3 years ago

1.2.2

3 years ago

1.2.1

3 years ago

1.2.12

3 years ago

1.2.13

3 years ago

1.2.10

3 years ago

1.2.11

3 years ago

1.2.16

3 years ago

1.2.17

3 years ago

1.2.14

3 years ago

1.2.15

3 years ago

1.1.1

3 years ago

1.1.0

3 years ago

1.1.9

3 years ago

1.1.8

3 years ago

1.1.7

3 years ago

1.1.6

3 years ago

1.1.5

3 years ago

1.1.4

3 years ago

1.1.3

3 years ago

1.1.2

3 years ago

1.2.9

3 years ago

1.2.18

3 years ago

1.2.19

3 years ago

1.2.20

3 years ago

1.2.23

3 years ago

1.2.24

3 years ago

1.2.21

3 years ago

1.2.22

3 years ago

1.2.25

3 years ago

1.2.26

3 years ago

1.0.77

3 years ago

1.0.76

3 years ago

1.0.79

3 years ago

1.0.78

3 years ago

1.0.80

3 years ago

1.0.84

3 years ago

1.0.83

3 years ago

1.0.82

3 years ago

1.0.81

3 years ago

1.0.88

3 years ago

1.0.87

3 years ago

1.0.86

3 years ago

1.0.85

3 years ago

1.0.89

3 years ago

1.0.91

3 years ago

1.0.90

3 years ago

1.0.95

3 years ago

1.0.94

3 years ago

1.0.93

3 years ago

1.0.92

3 years ago

1.0.99

3 years ago

1.0.98

3 years ago

1.0.97

3 years ago

1.0.96

3 years ago

1.0.28-a

4 years ago

1.0.62

3 years ago

1.0.61

3 years ago

1.0.60

3 years ago

1.0.22

4 years ago

1.0.65

3 years ago

1.0.21

4 years ago

1.0.64

3 years ago

1.0.63

3 years ago

1.0.26

4 years ago

1.0.69

3 years ago

1.0.25

4 years ago

1.0.68

3 years ago

1.0.24

4 years ago

1.0.67

3 years ago

1.0.23

4 years ago

1.0.28

4 years ago

1.0.27

4 years ago

1.0.34-a

4 years ago

1.0.73

3 years ago

1.0.72

3 years ago

1.0.71

3 years ago

1.0.70

3 years ago

1.0.33

4 years ago

1.0.32

4 years ago

1.0.75

3 years ago

1.0.31

4 years ago

1.0.74

3 years ago

1.0.30

4 years ago

1.0.37

4 years ago

1.0.35

4 years ago

1.0.34

4 years ago

1.0.40

4 years ago

1.0.44

4 years ago

1.0.43

4 years ago

1.0.42

4 years ago

1.0.41

4 years ago

1.0.48

3 years ago

1.0.47

3 years ago

1.0.46

3 years ago

1.0.45

3 years ago

1.0.49

3 years ago

1.0.33-b

4 years ago

1.0.35-a

4 years ago

1.0.33-a

4 years ago

1.0.51

3 years ago

1.0.55

3 years ago

1.0.54

3 years ago

1.0.53

3 years ago

1.0.52

3 years ago

1.0.59

3 years ago

1.0.58

3 years ago

1.0.57

3 years ago

1.0.56

3 years ago

1.0.20

4 years ago

1.0.19

4 years ago

1.0.18

4 years ago

1.0.17

4 years ago

1.0.16

4 years ago

1.0.15

4 years ago

1.0.14

4 years ago

1.0.13

4 years ago

1.0.12

4 years ago

1.0.11

4 years ago

1.0.10

4 years ago

1.0.9

4 years ago

1.0.8

4 years ago

1.0.7

4 years ago

1.0.6

4 years ago

1.0.5

4 years ago

1.0.4

4 years ago

1.0.3-b

4 years ago

1.0.3-a

4 years ago

1.0.3

4 years ago

1.0.2-b

4 years ago

1.0.2-a

4 years ago

1.0.2

4 years ago

1.0.1-c

4 years ago

1.0.1-b

4 years ago

1.0.1-a

4 years ago

1.0.0

4 years ago