diff --git a/src/docs/get-started/smart-contracts/v-atomic-swap.mdx b/src/docs/get-started/smart-contracts/v-atomic-swap.mdx index d91499faa..c43a40266 100644 --- a/src/docs/get-started/smart-contracts/v-atomic-swap.mdx +++ b/src/docs/get-started/smart-contracts/v-atomic-swap.mdx @@ -2,7 +2,7 @@ # V Atomic Swap Contract -## introduction +## Introduction The Atomic Swap is a method of swapping coins or tokens in a secure manner that requires no trusted party to hold custody of the coins. When swapping coins, the two untrusted party runs into a problem, whoever gets sent the coins first can simply abandon the deal and run off with the coins. @@ -61,8 +61,8 @@ pip3 install pyvsystems/. Now you can import pyvsystems in your own workplace. -register an atomic swap contract +## Register an Atomic Swap Contract ### Initialize the API Connection diff --git a/src/docs/get-started/smart-contracts/v-escrow.mdx b/src/docs/get-started/smart-contracts/v-escrow.mdx index b096e98de..461e4d42f 100644 --- a/src/docs/get-started/smart-contracts/v-escrow.mdx +++ b/src/docs/get-started/smart-contracts/v-escrow.mdx @@ -4,4 +4,221 @@ ## Introduction -V Option Contract coming soon. \ No newline at end of file +The V Escrow contract allows two parties to do transactions with one another if they have mutual trust in a third party. It is expected that the third party will be a large trusted entity that receives fees for facilitating transactions between parties. + +A simple example would be the delivery of a physical object where the recipient pays using cryptocurrencies. Once the delivery has been made, the trusted third party can review the evidence of the shipping/mailing and distribute the funds accordingly. + +## Implementation + +The Judge should register the V Escrow Contract, and decides the token the funds will be paid in, and how long the recipient and judge are allowed to take for their actions. + +The Payer will create the order and decides the amount to pay the recipient, the fee that the judge receives, and also the penalties for all the parties if they do not perform their actions within the allocated time. + +## Using the VSYS Python API Wrapper pyvsystems + +To generate and broadcast transactions, we can use pyvsystems to test contract functionalities on vsys chain. + +### Install pyvsystems + +**pyvsystems** can be installed by first cloning the github repository. + +```python: +git clone https://github.com/virtualeconomy/pyvsystems.git +``` + +Then using pip, we can install the repository as a package. + +```python: +pip3 install pyvsystems/. +``` + +Now you can import pyvsystems in your own workplace. + + +## Register a V Escrow contract + +### Initialize the API Connection + +``` +import pyvsystems as pv +from pyvsystems import Account +from pyvsystems.contract import token_id_from_contract_id +from pyvsystems.contract_helper import * + +custom_wrapper = pv.create_api_wrapper("", api_key="") +# chain = pv.Chain(chain_name='mainnet', chain_id='M', address_version=5, api_wrapper=custom_wrapper) +chain = pv.Chain(chain_name='testnet', chain_id='T', address_version=5, api_wrapper=custom_wrapper) +judge = Account(chain=chain, seed="") +payer = Account(chain=chain, seed="") +recipient = Account(chain=chain, seed="") +``` + +V Escrow Contract ByteString: + +``` +neYvWKcRQc7czFuzGcHiQrZDaFXXjyX3TeD43tojTqu8vRgdDaF7B5wJupyvKn7RMFQrb5dRMzf87VPa6kSk5v4zWYQAvDqvf34uByuekBA3CHwyBUvFmN2LGUx3ktTGcf5k1zH79jGnY1waSXqsB82348aSpKyzUiKvFko1DFM87FS6SxntjFYVyaZtCqvyd3NMRPZXaZUqLuHHJUNd63zhxMoYA6QokeoDnCM4HWXx3tvz9KYP1L8MpkusEac6yv5FFqhKkzBSwBPkSH73VtGYdFNpeBuTCeracN4WbAWnDrt8jD4cnUYNDQxuPTuczuZ8UApc3wYcM6Vp7LNgtZr5X9WxrarU4N8AsDXMKuwrRDQ3nZprW3BZFARjRhZs9TBqUkazXAbm5k3jfYqEncMPGBbmbr3HdeohsCv8t9uWPT7YBVr27ykaVDHc7NSxxFCHVefqGYQV25AwwGE7ax6MiZCwAibbuZS2hwXXKnTHY89K8jp7hqva9WvMtXtHaDyoXiJdrAaUto63F9bkWrJzVMkdsdqdm4BMF6Kgg7q4H7fwyKNeDxjYeYVT3SYhhntCaKqnNmCpENScHCwCEiJAM9S9ZTHqE3so8kt31rmx92xbD2pQgNHRzSVenDng7DxGJr1sHnzciX6cQRbgaVWycDJiqax79KRxWhPAnYyJQgh1RHHKz8utpocsFgYm8rkiwnzY3biA48EA2FaTqno26N4W58nU14g8xAG4wjGZof9NAMNqc5zBpKTDYov53xLEEJArhbrntyyAYUiWdpqZznzJoaXf6EitKZihRXBuGCgCZ8dpZCwwsfnpEmhNBZEyxGZ3h1P4aG9UVTSu35UNSK6sqvstZtz1bGiYycY4dxdUqQVVzgLAsVMUkaWu7ETKPbw4CJv72oDN48LgBFmLKdtCrkLipVf79CFS6xVUWJ7usK4XxtmnWDjGWvYQNZ62QSWCwTy9SXZDZQMk1qRXYBsfbfpusXGPM4ofT9F7D1GrmEevNZ9pqmkLdgchhm5iwR4hnbsZ7hzJoprLMUG8wtbDKpZeuNYTio4KfRRhAYJmYqNEL15hBfw2yWYDYttUQPe3VYcVE13tWFxuLpjwNgdycHVZxfoLMYoRUMKyCdz2sXuTPQ9EbCF6BEM29ncp2JEiZxJ3unPnwTu3vVUb4ad236qkQ3CfubCAkNLw7huZquMAktPbWEVCPAAp4USXeH84Yt91z3LqtBCx6f6B9UFwrCtNQ1gX8NpmA4sBwJE5iECsc81JKVFVMNhdDZB7wb2HaRyuuiRWhAbQujJGs7dQ8rnaXff9TR4cNK21L36uALBP8iKicb1JRzT8t6idopvSJLphAK3qBQa4Tc3UJpLNsJgMPuGfcvy4pjYH5tL2t59JGibinsmL6fJcYvhXWxSsrZviF5sJxstUvzGmZjxZ3gxcQpGT9CumdE6UJqkrNrUoqt7ZDW4RpPH3fYknrbNsM3gra2R9v2Vc53SQsu1w5SWxTHBqxCAxndBddzM7jhZBvgheJaN3eNh3NdM9WZDZHzWheqYhSDNXQJfMqvNzNq3GBar2Gt8aY1fqZovsFtt16bhfvPXsTixStEnDoiQSy4QgorEryppCckbySpf3pstFtm9i3w5NHCZ4K9eybaWCdN2mKZK2Npv2e3Rj2uchPFWRMWfMyzEcLAPyWjXdF7tPUbrPfp6xK9i3FfpJbKtzaA4VpYx68hWExRe4NiKHteHENTWth8dEqz4GkbJyDaXnJgmRzppw5csdVY8at9rSHqPjq9jXvY7WV1Cfva1rhtrDkFGZ2peoBUGi1U418EVsh5vX8XVHmdf359BU8W3Uk1ChXa8hc67dbz4aMkR6scehz3FxYE3DCUwJ8k9wPxGkrQri4hKUzzoKpCmboeSPYjyiJYrcmSACRifUUEnqVavA38Xe4NSaPxCZeFzwbtEKhLLjdScNosBRZt3kVPPoUWmDVatdzeTtpvTd8KAysju8ruCqD51nU2sUd9yiZbBV3TNRSDsz6BW87nZRewfvPdyx7WQniyyE3Kfww7Q8enAk57KRiSizVaKB3waK68rE76fXzHjCGfkU3UXp9pUsFx41u7BQtpw8VJDWnqzTGyzppntLG4PVh9cQWsGh1dQeapQ5Kx4jFSdGGaePUuXcdfDZ9eXS6SrQEgd9ZKVFdTEAVTeVG2abwcLKoSdF9H8sBtaresTokAUJZfynY5tvnVmCKLaPHT1rBAoAZWennU2XEF6HS2AoHHdCd8JsAfypfpUxTdNGVdQ4JNLNbtPVj6yJw46dYbXjb4HbuKi1bsJjERL3f3HESF5xogqFADA1ApJRsDisSHtqCZhUZXCX8nX7wU9T3hSVp75bnthWZ86TmXPfPkEUnsQryMfGo5sbveJYMP4XUT9TuXphdx34oahDpensuwXvft6BbnfwwSdYjsFdDuRtieUaLad359shRy4KkEyRwPDvVhEc1itqcyWTGzXZs4f7xvJxU3AjzEEjQoBWDYELGhafy2wEoRCSEmMxFPyaumuqyPXiD1usjTXyMsYPRy9pc62c2G5BWB6JEG3z1N82Ps8VH9EcioDrh14EHAuYQ4f82tCqmrx5QWQL8XBiQLofEy8LKDEgKrkYZeFi7nkvnxfezMfVpq7CdGta65opj5C8q43YrN3Gqvu4Bfr97pehzrNxbijLqH31rx1n1aejg5QEiSTT4ajhkbPzZQN6PEbVtHeoaZFw5ZrUdkhV5uage2z3wYKRPTuMmre6dFBevgaH5m9abtTKzM1ZkuTx4nHipV7TnCsRU7ivGgvrfbUcypa8M6FzdjTwvmyjXXnpNivT9waXyxuNMQPgwDt9jFcdP1DkV3utSiE5EGkgUTYgmhDrNwkUpVzFBV5epmee5vqNmbrSfUXvtpv7VWwx9EZq1mK4hxZKTXoMtaAJ7ia87KDKwTcy89gW1iRh1XfA6h9uKdAUz2vhc2xPSxbLEasdWnrZ66GfrQQFfsqzgGb7T7VCzNCMuAFTn9Ziq3qJ9BuBuT8tEnmoFkhitEexeFjaUS9bh53kbnudFK9HzC4KZ8DsLwBUxygnvS7RQjWfSFcv4DJBKVmjN7iBFyCnk6AuY5oXqZSn9JW9yhKyNpBqyxNfDRujNc4jfQku6R8dCZMFcz2EimxQAWV76cFK1HZtRAZcZxoKrLHk9QmgETkXkdcScbQVBkUGa92s5cjUoD5JzEovb612neaZPRK7Z2nCMAeLjUutVqrqrUpY1RprM6DNTvK91hCgGJEiEfeoAnJDrAt474NY6wLp5th4L2J2YA5hBDabjFeWBy8u9ZwxxPyG5vyHKmgLqwkyXeKaCwoEzQjWPFnXmY4eW66bSqXq2Uzgt3v4a1vqmaMNCeUsMsNtG3GhL3tLgtA669E3VcGKk51HLrdE7yu5mPX5NEng9JkydtRBseP3wJyfSFgW9LU5eNo6Dv8W6xt4ZMV8piGPmDvCm9Ue6gQyTTfUwXHjaC3fXPGz7mL1DoxreMqRf8ajqz66iwHibujaW25kR5ENoNvH7tASBQFesXny1oBkwdQkyYFBDE5qJZqt9qd1YFC7g738C7E2HBFfmFvTG8cXUCaeDVdcvzm3eQCVv3b8drauKQeQR3prJDtdt1Diingsg9MhL4TPuEg4T6eu9UeqrVpg7CURNFPhBMEEtdLT4CTjTVzv6oRHw7TqguMKGaSUWyDBrPrbExPq28zCCSdcFwoSm91Az9KDYnYuXdS52ZBMyASifUVoFMqWeEELR2vc4hG1wpvBKT3qHv8gTiCGTtxP6cjkoAJGszM5xbLo62HywyVQu8AKer36QbC1SQkJwGAioHuTjoKKJDMyGrEBtTsTkbH1Btk4pjPBXPMQvjcAQzVPHcRjMWeNVnmmdrx1PP5fU5PKeB8Ww5c75e8dDQrnK6m7Fa4wjaPQMetTgP4ESfGxXgioEbm3mn7e3nwma2rMxW1RqrzyyE8V3ZmHf6qmRQFdpJAvdfWHDwWn5e1t9sn3j292vwmPD27Z2JLQZXUYK7t6LPrjdeqgqf2GRhkYbv8PSM6pKCmGXsXgnabvjhfEH2ep5bD7N92oBWTVxPfBCY983RgcdbFeD3eVaUMXm4xe6jm7jbprEi1ZdjwGJvdLNvrDavHGRnM9ujtmcbiCH3vrkCd348WnGaL6CWjAfwPeEK6PwL3XR3rc1hJ2EPydekHxPtXAUn52WtTf24SqyAuTqBr8AdWdcXDUixd2rnBNDA8DmmDgRCHdqsL5cQdYDiv7RWEtHP6RkXh4A8StsXU6gwJjpK7ESYe1WLHaHiutAwtBEknKecSxywB3ShbQHa3kmY5LXuHwCam8M2P3s3MMeGcKUsadxLqKwRt7JG3Fy9dUuwzaD2gtLkde8VBcqakzcCAgtrsiC5z2Nohtrb1yBNH581TwzTwK3YyyN7Fn1EpHLzzZTWiziAJwwDommXn3VQbW2LgMn2jcuhNtQbnp4mFupHyvMfkfSTUAWLxvWYseacMYPTDK4jfpghukDnGkF589Mfz7sLFcEAsVYLas6kAo3P9DSi7kgthoaKXqtwuiva6YB4CtZYtpcBfvaSYzgvq48nvzMEWKyZCTQEFEe4TRZFyTrEPGygfJVTPCigeQDTbjCXc2DscpDLpfChk9wS5CgYxhyweUJi8T8uqBz5AZkzTj5wPm2Rx1kunfnCJdjXoRYeSpSRKeqh5RQbTHcBgZLKW722pvxEgCyrNKmMLdBjv3d3nmJ3B4Wfjs6Pei8hM2ouMosNnT9Czy9WX2zHpNzYso4JPwhFWDaxMnU1ToWY37dXviptwsLKmmsLujjpwjCp1npRowUJsmuQiVpdqPbPn5ACdBiQEnt4SbeY5933DVP2JpeL2NorUByaMJM4QR6QxSzoKRo1HKHy39wcJdcYFQ3XphebR3c2tHyvjPuzMw9FKkW6jABmBWL9PmRjde7rgFFnThEVKt94n1pKoFjRb1BKcoDqrc4jvKVevu48WVK85AiqBnuhD26zybQtsMFgSTf364B95eoVBk1fSsDkXHkvvquBVZ4yC4tiFd2rXsnBr4R2syTD99wmoh61PpXwN2BAifqMVbhD99WxJtCt2qdthKWhCprqKzJcLPj8KN35MqgboYNPrFCihoS6jyUQRFPzaNBcqkaKrurtMaWTe1LAG1DMvAUiBGjPuHb7rPvuC4jjSNsBJL8TMeC149ni1jn1UriEnZqPrB9tLuHHcP42D7WtztqbyRcwvA3EQRJT9UhbY1zfkg7Wdq9ZwKkb3Wzo4MwFxGu5VUzzDPCSUMAdRny5c5dejFeJrK687kDT6HwidwzYRLgY1CVmSK1VrcUwPxNxQQ58etAQFuw8PiigBTnwQZaiu2z81uyqpUJ9KYhnzHjLC5YwYg14XEmVpQKCs6rW6SxVDD4JqU8GvuAx1Tig73FCwjvR8Miz7K77pUsyVtJ9s9c36qGm8aC2wRTvHP68H1HfQj9z2NVcswfyFd1LoL7wqn16FLqEY1hvaK4kBpWZDV72rmrgZqGDb6ufFQ6rvhk6LfM7W9GVtDciwCWdxTuFHVJQUUHsDWbRq9kxrny42ogTC5R6CXPUo6xLbSEevN6k7N9Zwmc5QY4ZevHcmJYS5ztQ8CDbA3F6b3jZiF1nFPFCCZeAUjhH6ACV9bnvVFX6NYPhEHpw9sznzeTQSiHSUWwqo1VTGsGVuoB42mSXiVhjZ9D4LKMc58AHsxq5EKzwm2hC7zHtPwCcgzYcSBS6mdLXYvPSUYx6jCE6GdRaR989p4own8XRC33YU1kG7m2FVq8gMikVUKH53Xk4u4G5PcZ44rrcRv7qJGmvq3a2e8EhKETdE4stoUs3H8StG834q2R6uLGqHsXMJ4LbB477EKwj62dm5BZsMgLnWv8txz2VUZpSwRosncB5Jp7obwrJ7ihSRWFQjFJirH9LcwwmPwEipSGNAAE18F78pN6kxbUkLpjEqTKh8eu1rvWgqozV35JajWWgodpdFN8nGEFBTx4SJW5R9RZfoo8ScVNAafCG9xDXKxgUGMj82WjsfJYvFyqDTUsYRy49jZomALXyeN4SjrU5yehhqXMvrHEEKdFcmAsYme336yFRdQ2hBQvPSE2b2tnWe3pr9zxHTYQFXjKo7QEF6N62cmMPve9rhvJEWMdcXBDrwDEFySKsJSeMPWzuc9v3rL5qScNpMbp3KGCW6nBBW27E83TSiAUtkY9FKCo3gdbgpTqrS5QSZ531Eqp1KFnaB46C6idScLortbyFquQ6si9FUVJK6GqQWZYFnzh8v8DeYdPE6z9C4Fb2Svuf6Gvh7Lwd853eDChAWUZsQwYjmZka2esqjv5cfprNxm7G7AAVg8DEhiChExkY5eTCm5NVQDiq23jiYcqjMmsFZ3eWEA6tGPi3KVMTkB2ttMVARk72AyRw14Gfb56bDXTbwEnUN2f3zHSNaARfz8mS6SbkRZ7nKtSZsqL5GmjqYL71yrhutwrpgv1rqT4XgqgPJSu6hXpnDo7VXvCjmQkLeMvdjSjBsEgn2BLFKJ3DTTssGbuTWyeS2pDVpv9TCxbeFjYmqndJtVWhKbGoeMCQ1FvijSwjL5kobeoVCBqDvEjEVkHsmTdXiRTysuEvipVQfSzGPXjSx2pKh6M4ejGNjnev18hgvaNYaLMoU84CMpYQ7gzuZXPkhFReNvwMycoMCRoMyyracAzSsp9apni7AVTbs4hBT8L7jBq4Ttce8ewqMtPdzRhrHpip6d1RP5pCQ7DSgYCtAi9kbsiXMCuafHjHmJbSbfdkcgs61svjNTGH9xLjBMxpEpRCPTg28dgTqNMh2UY6vknGNhFzw8hdryGVmkrWtFHhaVMEx25M3egmbLEmm6or6haM4EJvDtUDus5Hgxda5toxz2Mzgi2or7HJAU4Mef3pWWixkpSQcBBDDKwJas6xQkny6Dw52mmyJkiyqVhCWtRwHXw1JSKkdgfEdY68nmTuTYCxMkNcDCXQRyw2SSivfwW3G53dcm4si8rquYAk4Y4Ekq6MaHN8aqv3a6BJ7tNEFVQSyDvJYtnA2Fn9eXtXm1eV97dL7BYgwMyPurvay2YiaTMcUXPHh3xHUePq38M1A4fQXSiBxhi1nb4VDDWbr3FhaTsk2aPJL7ALLrAFcvZWJr1WeCDyH2WNWD3mFcqiykQwauNcUCqrmrsyLVUpFXHicqLh6SMdxLneXcNfAPhi8dKvxrm5UkToSamHbbxZyDQFqm59rzX95VABSurbFe38YfEWgPQAhMFuuCy9yNsAAdp4n9mVjPsxZTfUk6QcAL6qa5SFwj7Xb8frUfiYzLYjWBm6CqUyrbocDFWryiieALKLKuJ4nnHF5Tcd2rWBydd4sRLb6WvNoy36BRdjRkohb5MXLRkccgjVVHFhjqkLiKkF6bNyCRmzbChesKUPPWhD3j2wcbDFfq8UmqxL1dndy5sV1GXN1EPs8QyckywYVKr7u3aBrw8qokLevTGoos1WcvLFiZQEkqrfsjKVzJdq52Tu5x7SdTMHFUUw16TKagZNtLYFNP2ZbqqLbDuBJjM5A8qkaYRQ93iqGJ8T4MkCJPRBqCxbzEG9NjQsfKdwgsVLryXA1MV4PeMANjk94fBKyJuCm9CMUtSoaDGNDs2XcUhQRdeAqhjrpc5FN15AHHGz7t2vySQXu2aYfZ4TwL5X9ZFQfrZgQjGwwqKJC3BTiSD3RdzEbTXYVTQhtKUAaZdbzzXbpipP7qpAetZhuRZbyLchdcvqGPXyHVAhn5YTbVmYqChzsUaK6jhrcnCHV37HyBR2HAQG8BMkwJffcm8uD259JSYMmrKbgvQggXcXdCfh2bu3qHgZvbwsgF9vkjAwWhsJz2BGdRDSRGhtqDc8hjcYRSBMizzFEpQytET4KRUJqHPNhVgfeuDiPPRivH1s1D +``` + +
+ +| **Triggers** | **Input** | **Input Types** | **Description** | +|:------------: |:----------------------------------: |:--------------------------------: |:---------------: | +| Init | (tokenId, duration, judgeDuration) | (token_id, timestamp, timestamp) | | + +
+ +``` +v_stable_swap_helper = VEscrowContractHelper() +token_without_split_helper = TokenWithoutSplitContractHelper() + +token_contract_id = "" +token_id = "" + +register_v_escrow_data_stack = v_escrow_helper.register_data_stack_generator(token_id, 60000000000, 60000000000) + +judge.register_contract(v_escrow_helper.contract_object, register_v_escrow_data_stack) +``` + +
+ +## Using V Escrow Contract Functions + +
+| **Executable Functions** | **Function ID** | **Inputs** | **Input Types** | **Description** | +|:------------------------: |:---------------: |:--------------------------------------------------------------------------: |:-----------------------------: |:------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------: | +| Supersede | 0 | (newJudge) | (short_bytes) | Give judge rights to another address | +| Create | 1 | (recipient, amount, repDeposit, judgeDeposit, fee, refund, expirationTime) | (short_bytes) | Create a Escrow Order | +| Recipient Deposit | 2 | (orderId) | (short_bytes) | Recipient deposits repDeposit into the order | +| Judge Deposit | 3 | (orderId) | (short_bytes) | Judge deposits judgeDeposit into the order | +| Payer Cancel | 4 | (orderId) | (short_bytes) | Payer cancels the order | +| Recipient Cancel | 5 | (orderId) | (short_bytes) | Recipient cancels the order | +| Judge Cancel | 6 | (orderId) | (short_bytes) | Judge cancels the order | +| Submit Work | 7 | (orderId) | (short_bytes) | Recipient submits work (evidence should be provided that the work is complete) | +| Approve Work | 8 | (orderId) | (short_bytes) | Payer approves work and agreed amounts are paid | +| Apply to Judge | 9 | (orderId) | (short_bytes) | Payer does not approve of the work, and asks the Judge to judge the work | +| Judge | 10 | (orderId, payerAmount, recipientAmount) | (short_bytes, amount, amount) | Judge the work and decide how much the payer and recipient receives | +| Submit Penalty | 11 | (orderId) | (short_bytes) | If the recipient does not submit work at expirationTime, the payer can submit penalty. The payer will obtain the repDeposit and amount, and the Judge will still get the fee | +| Payer Refund | 12 | (orderId) | (short_bytes) | If the Judge does not judge the work within the time limit after the apply to judge function, then payer can refund. The Judge loses his deposit amount, and the Payer receives the refundAmount, and the recipient receives the rest. | +| Recipient Refund | 13 | (orderId) | (short_bytes) | If the Judge does not judge the work within the time limit after the apply to judge function, then recipient can refund. The Judge loses his deposit amount, and the Payer receives the refundAmount, and the recipient receives the rest. | +| Collect | 14 | (orderId) | (short_bytes) | If the work has been submitted and the payer does not approve work or apply to judge within time limit, then recipient can collect, obtaining the order amount and recipient locked funds, The Judge gets judgeLocked and fee | +
+ +**Deposit Into the V Escrow Contract** +``` +judge_deposit_data_stack = token_without_split_helper.deposit_data_stack_generator(judge.address, v_escrow_contract_id, ) +payer_deposit_data_stack = token_without_split_helper.deposit_data_stack_generator(payer.address, v_escrow_contract_id, ) +recipient_deposit_data_stack = token_without_split_helper.deposit_data_stack_generator(recipient.address, v_escrow_contract_id, ) + +judge.execute_contract(token_contract_id, system_helper.deposit_function_index, judge_deposit_data_stack) +payer.execute_contract(token_contract_id, system_helper.deposit_function_index, payer_deposit_data_stack) +recipient.execute_contract(token_contract_id, system_helper.deposit_function_index, recipient_deposit_data_stack) +``` +
+ +**Create Order** +``` +create_order_data_stack = v_escrow_helper.create_order_data_stack_generator(recipient.address, , , , , , ) + +payer.execute_contract(v_escrow_contract_id, v_escrow_helper.create_order_function_index, create_order_data_stack) + +order_id = "" +``` +
+ +**Deposit to Order** +``` +recipient_escrow_deposit_data_stack = v_escrow_helper.recipient_deposit_data_stack_generator(order_id) + +recipient.execute_contract(v_escrow_contract_id, v_escrow_helper.recipient_deposit_function_index, recipient_escrow_deposit_data_stack) + +judge_escrow_deposit_data_stack = v_escrow_helper.judge_deposit_data_stack_generator(order_id) + +judge.execute_contract(v_escrow_contract_id, v_escrow_helper.judge_deposit_function_index, judge_escrow_deposit_data_stack) +``` +
+ +**Cancel Order** + +Cancel if anyone does not agree to the order. + +``` +payer_cancel_data_stack = v_escrow_helper.payer_cancel_data_stack_generator(order_id) + +payer.execute_contract(v_escrow_contract_id, v_escrow_helper.payer_cancel_function_index, payer_cancel_data_stack) + +recipient_cancel_data_stack = v_escrow_helper.recipient_cancel_data_stack_generator(order_id) + +recipient.execute_contract(v_escrow_contract_id, v_escrow_helper.recipient_deposit_function_index, recipient_cancel_data_stack) + +judge_cancel_data_stack = v_escrow_helper.judge_cancel_data_stack_generator(order_id) + +judge.execute_contract(v_escrow_contract_id, v_escrow_helper.judge_cancel_function_index, judge_cancel_data_stack) +``` +
+ +**Submit Work** + +``` +submit_work_data_stack = v_escrow_helper.submit_work_data_stack_generator(order_id) + +recipient.execute_contract(v_escrow_contract_id, v_escrow_helper.submit_work_function_index, submit_work_data_stack) +``` +
+ + +**Approve Work** + +``` +approve_work_data_stack = v_escrow_helper.approve_work_data_stack_generator(order_id) + +payer.execute_contract(v_escrow_contract_id, v_escrow_helper.approve_work_function_index, approve_work_data_stack) +``` +
+ +**Apply to Judge** + +``` +apply_to_judge_data_stack = v_escrow_helper.apply_to_judge_data_stack_generator(order_id) + +payer.execute_contract(v_escrow_contract_id, v_escrow_helper.apply_to_judge_function_index, apply_to_judge_data_stack) +``` +
+ +**Judge Order** + +``` +judge_order_data_stack = v_escrow_helper.judge_order_data_stack_generator(order_id, , ) + +judge.execute_contract(v_escrow_contract_id, v_escrow_helper.judge_order_function_index, judge_order_data_stack) +``` +
+ +**Submit Penalty** + +``` +submit_penalty_data_stack = v_escrow_helper.submit_penalty_data_stack_generator(order_id) + +payer.execute_contract(v_escrow_contract_id, v_escrow_helper.submit_penalty_function_index, submit_penalty_data_stack) +``` +
+ +**Payer Refund** + +``` +payer_refund_data_stack = v_escrow_helper.payer_refund_data_stack_generator(order_id) + +payer.execute_contract(v_escrow_contract_id, v_escrow_helper.payer_refund_function_index, payer_refund_data_stack) +``` +
+ +**Recipient Refund** + +``` +recipient_refund_data_stack = v_escrow_helper.recipient_refund_data_stack_generator(order_id) + +recipient.execute_contract(v_escrow_contract_id, v_escrow_helper.recipient_refund_function_index, recipient_refund_data_stack) +``` +
+ + + diff --git a/src/docs/get-started/smart-contracts/v-option.mdx b/src/docs/get-started/smart-contracts/v-option.mdx index 9b86b413f..24a7f13c7 100644 --- a/src/docs/get-started/smart-contracts/v-option.mdx +++ b/src/docs/get-started/smart-contracts/v-option.mdx @@ -1,7 +1,437 @@ +import image001 from "./vOptionContract.png"; + # V Option Contract ## Introduction -V Option Contract coming soon. \ No newline at end of file +V Option Contract provides an opportunity for the interested parties to buy or sell a VSYS underlying asset based on the determined agreement(e.g., pre-determined price, execute timestamp and so on). It allows users to create option tokens on the VSYS blockchain, and buyers holding these option tokens have the right to buy or sell some underlying asset at some point in the future. Different from the traditional option market, everyone can buy or sell option tokens to join the option market at any time without any contractual relationship with an exchange. + +## Implementation + +When registering a V Option contract, it takes in base token, target token, option token and proof token as inputs. The option token owner has the right to decide whether execute the option contract to get the target tokens from the pool and proof token represents the percentage of ownership in the pool. + +
+ +**Initialisation Phase** + +Market maker requires to register both option token contract and proof token contract for use in V option contract first and ensure that option token and proof tokens are FULLY issued. And now, market maker can register a V Option contract by specifying the token ID of those 4 tokens. After that, tokens need to be deposited into V Option contract and it is neccesary to ensure that option tokens and proof tokens are FULLY desposited(i.e., token issue amount= token deposit amount). Finally, remember to activate the contract to deliver it to the next phase. + + +**Participation Phase** + +Since V option contract is well-prepared in the previous phase, people who expect they can get the potential profit from selling option tokens can mint option tokens (and proof tokens) for selling purpose. Those option seller can also unlock the option tokens freely to get back target tokens from the pool before the execute timestamp. + + +**Execution Phrase** + +After the execute timestamp, option holders have the right to execute V Option contract (with base tokens and option tokens) to get target tokens if they consider that the contract execution can bring them profit. They can also decide to give up the right to execute, in which case they will only lose the fees paid for the option tokens. + + +**Terminated Phrase** + +After the execute deadline timestamp, proof token holder can collect their own crypto assets (base tokens/target tokens) from the pool according to their owned percentage of proof tokens. + + +## Use Cases + +As mentioned in implementation, here is some uses cases to demonstrate how we operate V Option contract in these four phrases. + +**Selling Option Tokens** + +As the interested parties predict that the relative price of VBTC/VETH will drop after 3 months, they will mint the option token with VETH tokens(i.e., target tokens) for selling purpose and they become the option seller. Option sellers can take the option token to the exchange (i.e., stable swap contract) or through some Over-The-Counter (OTC) service, so the people who expect the price of VETH will rise after 3 months will be interested to buy the option tokens. If option sellers want to get back some target tokens or there is some remaining option tokens in the pool, they can unlock option token to get back VETH tokens before the execute timestamp. + +**Option Execution** + +After the execute timestamp determined in V Option contract, the option buyers (holders) have the right to buy VETH tokens at the strike price with the same amount of their owned option tokens if the price of VETH token is beneficial to them. + +**Collect Base/Target Tokens** + +Option sellers call collect function to get back VBTC tokens (and/or) VETH tokens based on the percentage of proof tokens proportional to the pool they own. + + +## Using the VSYS Python API Wrapper pyvsystems + +To generate and broadcast transactions, we can use pyvsystems to test contract functionalities on vsys chain. + +### Install pyvsystems + +**pyvsystems** can be installed by first cloning the github repository. + +```python: +git clone https://github.com/virtualeconomy/pyvsystems.git +``` + +Then using pip, we can install the repository as a package. + +```python: +pip3 install pyvsystems/. +``` + +Now you can import pyvsystems in your own workplace. + + +## Register a V Option Contract + +### Initialize API connection + +``` +import pyvsystems as pv +from pyvsystems import Account +from pyvsystems.contract import token_id_from_contract_id +from pyvsystems.contract_helper import * + +custom_wrapper = pv.create_api_wrapper("", api_key="") +# chain = pv.Chain(chain_name='mainnet', chain_id='M', address_version=5, api_wrapper=custom_wrapper) +chain = pv.Chain(chain_name='testnet', chain_id='T', address_version=5, api_wrapper=custom_wrapper) +sender = Account(chain=chain, seed="") +``` + +### Register V Option contract + +V Option Contract ByteString: + +``` +5bQsSpKiuKvZyHK78ZrydbaW1yHd6RHmoBiP989auNA66f2xNQ6bFvrRjGUveNMHxbagCgTx9HSuWWN3rZBJo53Vcc7F9fN5JwKFw678y6JiKkjqoD2s2rNYGi2QTMhdHJrfHZKLcthzK6iFBJRUuZBF9NichdToC4q8C42C1sRqFQmP7XbVNkAMLrMhPstrG7p6HdGvn126yy8cT47JPVe7NAegLqsRzQwWXMoFqZsxUkQs1PrauRUXDeF9SPFJGKLQNEjFs64kgYWxV4AZNm6gK3XBfSEQTYoVWS2zX7SuLnrg6BAPyJMyzUVoNHjWFF5T83Mdh6Y4Y7goYvXdiypw92NSEn7PjqovJFA7NvEittrMnHjAwmUKxjE34UiPxQtYpsp735GcLCmZCkWQM5kTpnKDG4k4nRrQuhghKnYTMph48J5XBEcNrRPHdHX4bJmVgWdDXXzjfinS3q6kMgs4aSPjrnatNppG189iCFn2jBbJcSKf2GHnLihPpGaHiMxsr9hCxFM5jDERoKwVES5DXGdDDjBpDcMTSkxf54PoXCMvjauWnaCSjggqGwJMhhfJqeXDPBoibRXZt4H64N3cF4tX23KEWhbgRqmwvXpp5dsHS6zPj2QbfxvNaqZH2giwAvUuvQ2Tj5QunaXduaGzMhWTooiUaM4ecNDzYemwkyiRRokazRwmZG4xfxrhy7XM6soXJqjELu8PZE1ZqhAkTMrd2PWsSdCix7heE2c8jZGo56h4k6z3hNmu9KokrQVsHzUFHveN2YJ1aESjVV9N2GCv9qmh8Eh3JPEcZtyiSHF5YEFXKUkFeYp77osWk8JMRS9Mym3N9x6oYqjUttgQNaCyXnjyYoQGkSfpfVs9YtUB64v23zR5N63UL5FPYhMSBSHZ2ZR1QKrD9257jM52B4Y4xNeB6ZyxuqYGg8BpMqa7WFWhEKSpLiiecCMFRLtf5mx5Ss9SxqbrYCsNNaBLRSfVYDL1TwkwUKqqZmcmFH3zkZ7wQXfYe1MPLviVMrHereVqCULsz4aj3E2edQJLDYfrAh4a2gc61qKohBvc7QA9Fa2ZxSoztG4d1n5wqww9HxRehdrYoMNHWys75usrLDbj1zuDkFJx8FqaD6zS8EBWihp835wsa7sPTk61xNyR3egqai2PP6HhnuZ6SPzfeoWHUoSUQ1LHQQLRXYu75j8cJNjMgsguoZfU1BAR7HZzCyUgA7n6oG4AiNfxXcPzBJB8fRNWdNutFuB1g89Y9TqfPzxU7pAeRzBfrekgsDBDKb1V9kyceBExcgyC8nuWt7mTXRf6F83CnaTqfoxbQbigyVR96AKuq4bf1X745ZhDvMvZiFNkJDRdMF3DpKvn2GfaU4xhZdXfbuJ38fq6vy5h2NwA5d1oqCMYFQb6KXhgjkc2NaAPtRw4oqQQF2arqPnaF3yvFBmPzpN5Qh5xbDDwAeXAU9KrPTeAUNs95Y1F6CsKAoMfExo6FcJWVAycDtZNscv9vgrXMWKDVMfkyCUAJBaoEX8mgtux8hqFJ7kjQsE3uvZ6GkUde8EgGmG3G98kK4rMZporHoDY4Ee7CxrtUAXZ78Re96K4nkGYujjDjgJXToC9K8DRuPW9kAQoBX3WwH2weeo7Lq912NWV47339LGLFMsLAxWNEWxC4FcHfedPLpgV6cN4btusPVEV3LVXrpNBiQCVCtnJJZMzJx6Ap4P2V6Np9FySJPKkbnGwJiK8n2sPAdRnCG9NRAy68p1HGPtkeXUmu7HeNvH4vgGV2RHBvNFqeWZnAEFTEVSit5ztew9SpFYUFWmBYF2hukuuKxjE7NHNuGWiuAF2P5ozjKeCZRWTC5duDouoebgRTCRMvvG53z3h7iMvTCHLBVbrcZ2qwRasq234BmFTocY4UC9g9csWbSPXNszF7yUGbE16qVVi6mPADLZSj8XbChv49mVmm4ixcVnWR6Bm9mYx28dpXBWScScnLnrKcTzLAHm4UA5bG6WfyXfiFNwu5DhAPnt5Tjj7BsgyguwGwT4FLyLskxG1Gswfws5JHvQ9LBmoXQ6TtZyTZLjJqyty9xm6yHDY2abXHpVDM5RzQzQjEjoddQMujN5A7ydAUknL8knSUxCxFEnetEx3BET4EMz631QMz5deWB7M6FX9q2dm5rxjhRkdN5EZU2qeEgFon7TiWHtyquCUyiHGWPWWwqfj3XBUEn2GnrAro5wuM7i9zhJ26BgzsEYu3Ly6bZdayqgBSrfnJbUKRx35ruyguddj925tieJJmj3Ec3DXVzBL7sXPPRo2D4VonRbiAvU5sacpJFbv4EyuTsjExuAcFDgfE2cVWKNQfcrJQ3sWeqZTeBFyB2XCkzRSopyKm1UwzhXCkkgRL7YuWsuswvjTaZe5mQbP2NmWMcMLxwRUVMdPeqCR6F8gJmfByVhSkXQdjhUkvMabuUnqxP3Y6hZbGoK8DFGQGkwyfFXcw12LdaBLHqY49b8thpagU17DEDn22kahFE1WtiQU12ZSGu5jyK3DvgrEocgxWN7dFddpAZH1Z7ceu3zWprWRZJiJBkjnRSkoykQChPRjJuZNzJ2hMTei2WhgBBJ7anCot2jyCywpDqFPznEsn6Mjn3K2D7nvKMBXaDbQkaDW3NMZpPLN8riRik9TVJsENzfygP11zLqC5Af2X4LfbEu3VtCpvhiWvgNxyyb4LcgXw2oRWe6UrDTfb5iR33pGX3TjpvYPazZTNA7QejMXVvZTwvpivUirSAPQCKQs6EabP9SFRkph5RgLFB5RSidBGfGN7fmdjk5xZGc6wbMY3qgkbX136a3Z14UqmXpBM8WMxrVUqyqgH57imuek7De3fcVuJqcHZXzuVz5QLp6JJewn8bnysSsgCgUzvzy93m9uqDy9vLzyAj5j8q1wCEVwLYjWDPBMJkTu47oy8HHyt8T3xocTxVzwms8zJVwgg1ujVszK4SUpTzbQ8WMGCTpzqm5D7EbRs3jQbfPxweucLfDQX1D3QyfS9mHBMHZEvSKPd1tXZgLkB5VjspmW7F6xGod3nsiZNaroS5JPSHC2y6WnEFasWH7zFm66HDeqKU1TaV5rfeJkBHJ6u3YXWEVpHh1A8oPKigBFiUi7YdEeMJi1xKc4T3d5ND2G98dHwg6iJZRvd6kTEtzkYDqs7zuC3w4qbBfVbQsR3E4uoomNW7Z6w9jUZt61jNnjeRT1dkno1NKhe2iMXY2rrqR3Z8H9bfJdexMdsEXrHPNLyYvvQUrsQLuEmTkokXT6WH25HJBw1xvToGPz31twiHpb3VVGhgZp5A7o5v9vp6UypNn7GxYsasJApjChUGUChD7r7B9c8a9yZFA7Yutrq3yV9v2RAL6U7mcxiwPe3cXxXuosG9dK6YxuK451iZQ8N1cV3CLwgVvb5Y7p3aJtL3GHyQfFzNyPH7r6u7Dvhh33XMxriQ4NNVGLQ7iBfSAW6wXkBD5kcVoHrZ9jQxQRBEWGLhoqhhujGNT5XNVCcJzZi2r6WsN51s2kSNDwxw2bYNrQ1T2aGJgg7HgrjiA6GgBQBBbcg1EDC8EESii2qfdr2uDxZsQ365FNu86WkmJDrrqTLuqKQP3R1frkgDZLnMVih82gKXq4dCiGq1hVBQiRtA4LQgkEie9sjAqUr6pDHP96LWiih2Ud7VqT9RkLSSDqtMajEn3m4UY4vrxp4YvRE9NLakN7n9oBQKJxsALHKe2akbcstuefgCX1oe1Ln51wtS4CyZA9zhEJd2yv19aiAFaXUhxnYzPsaZdExNQMDKS5Tp7Zs8joMUaJFL4unTWGMStQbvyVFqMaySHxnPSSivewWm8kRpDD5YpPCyMJxXBK8GjJpndHHoE8qYc3Z7DHxEaZ3H3qMtmM2vpbuSizXFQfvVeiBMBVBeJQLxXsB5oubBEzDKmCaLgtzonoBtZ3j3SF4ZDkNSzvpEYC2UiD7ZURU7gwnWN6VaEVw6EDDb9kmNWKQpnJpcBTHk1XQyFVKTupY2WDNrU7s9LrRgzyyBasPF8nvnXD4Si4vGCtkdS5HFkUCuEh9LQ27FbkE1cwJ4fFfy73UtyQetKBN79czTgvnvixnmga8VRh1wvFWPGfB3i2mRZ7x1hq6ik8hL9i4Njasj13Sv139b853WWXkmYi9X4oh4bGcLb4jrWx4eskFq9k9QDdi33r3ZAQWegdxAkZRvyJhfnUkJVP9dNwqjLocbWvhn7LMQ5Y4JcHa4ybPTah9hVQZwBjGtQVaasU6XuZWeNRLMhw5XMmkRpyocSEAWqzM2iBACweUTCcTxQv9WfbmgNqA3a8TaFRN3aTgAAv8XjrtagpQW5k53fComdN8wGmzQaCW6ijW7VY8KkoSM6rTFUivSDLvcqcJ1CFCo2qruCJ4cGfTK3Fza1GM7PReR91VqP7m1YGZMA4fMs85k32zbjcUrDhxqRDAZDnTMjPAbvwf72PrfYrNQ9WeuBdtjmnwtQDRMBdhEEgJWijAnmu5ibX1ArxXDw5QtKBB4Yd1gK5Wm2gDhbgnPL76KTZUcN3VxuR4AV3H4yc8YUj3USbu8CHmfJSaQcKyrSLbpSG58MERRFbrLa8uc4nVke7NEUWd9pVmHsDEp81kxAXV72TT5zbiGRbydULxDtbLDGpcZ71GmYgApb8jYMCGE7XdwUWCy11hKVnH4wyf7ZBudeGW3Nc4T7LfXLuqkSSW89sKqSNiQGw35VVFhBtRtJDwXVgCjG8Hirm4G +``` + +### Insert TABLE + +``` +v_option_contract_helper = VOptionContractHelper() + +v_option_contract_object = v_option_contract_helper.contract_object + +register_v_option_data_stack = v_option_contract_helper.register_data_stack_generator('', '', '', '', , ) + +sender.register_contract(v_option_contract_object, register_v_option_data_stack) +``` + +### Using V Option Contract Functions + +### Insert TABLE + + + +**Supersede the Issuing Rights to Another Address** + +``` +v_option_contract_id = "" + +voption_contract_helper = VOptionContractHelper() + +supersede_function_id = VOptionContractHelper.supersede_function_index + +supersede_data_stack = voption_contract_helper.supersede_data_stack_generator(new_owner.address) + +sender.execute_contract(v_option_contract_id, supersede_function_id, supersede_data_stack) + +``` +
+ +**Activate V Option contract** + +``` +v_option_contract_id = "" + +voption_contract_helper = VOptionContractHelper() + +activate_function_id = VOptionContractHelper.activate_function_index + +activate_data_stack = voption_contract_helper.activate_data_stack_generator(, , ) + +sender.execute_contract(v_option_contract_id, activate_function_id, activate_data_stack) +``` +
+ + +**Mint the V Option Contract** + +``` +v_option_contract_id = "" + +voption_contract_helper = VOptionContractHelper() + +mint_function_id = VOptionContractHelper.mint_function_index + +mint_data_stack = voption_contract_helper.mint_data_stack_generator() + +sender.execute_contract(v_option_contract_id, mint_function_id, mint_data_stack) +``` +
+ + +**Unlock** + +``` +v_option_contract_id = "" + +voption_contract_helper = VOptionContractHelper() + +unlock_function_id = VOptionContractHelper.unlock_function_index + +unlock_data_stack = voption_contract_helper.unlock_data_stack_generator() + +sender.execute_contract(v_option_contract_id, unlock_function_id, unlock_data_stack) +``` +
+ +**Execute** + +``` +v_option_contract_id = "" + +voption_contract_helper = VOptionContractHelper() + +execute_function_id = VOptionContractHelper.execute_function_index + +execute_data_stack = voption_contract_helper.execute_data_stack_generator( + + +**Collect** + +``` +v_option_contract_id = "" + +voption_contract_helper = VOptionContractHelper() + +collect_function_id = VOptionContractHelper.collect_function_index + +collect_data_stack = voption_contract_helper.collect_data_stack_generator() + +minter.execute_contract(v_option_contract_id, collect_function_id, collect_data_stack) +``` +
+ + +**Deposit the Token into a Contract** + +``` +token_V2_contract_id = "" + +token_V2_contract_helper = TokenV2ContractHelper() + +deposit_function_id = TokenV2ContractHelper.deposit_function_index + +deposit_data_stack = token_V2_contract_helper.deposit_data_stack_generator(depositer.address,'',) + +print(depositer.execute_contract(token_V2_contract_id, deposit_function_id, deposit_data_stack)) +``` +
+ +**Withdraw the Token from a Contract** + +``` +token_V2_contract_id = "" + +token_V2_contract_helper = TokenV2ContractHelper() + +withdraw_function_id = TokenV2ContractHelper.withdraw_function_index + +withdraw_data_stack = token_V2_contract_helper.withdraw_data_stack_generator('', withdrawer.address, ) + +withdrawer.execute_contract(token_V2_contract_id, withdraw_function_id, withdraw_data_stack) +``` +
+ + +### Using V Option Contract Functions + +### Insert TABLE + + +**Supersede the issuing rights to another address** + +``` +v_option_contract_id = "" + +voption_contract_helper = VOptionContractHelper() + +supersede_function_id = VOptionContractHelper.supersede_function_index + +supersede_data_stack = voption_contract_helper.supersede_data_stack_generator(new_owner.address) + +sender.execute_contract(v_option_contract_id, supersede_function_id, supersede_data_stack) +``` +
+ + +**Activate V Option Contract** + +``` +v_option_contract_id = "" + +voption_contract_helper = VOptionContractHelper() + +activate_function_id = VOptionContractHelper.activate_function_index + +activate_data_stack = voption_contract_helper.activate_data_stack_generator(, , ) + +sender.execute_contract(v_option_contract_id, activate_function_id, activate_data_stack) +``` +
+ +**Mint the V Option Contract** + +``` +v_option_contract_id = "" + +voption_contract_helper = VOptionContractHelper() + +mint_function_id = VOptionContractHelper.mint_function_index + +mint_data_stack = voption_contract_helper.mint_data_stack_generator() + +sender.execute_contract(v_option_contract_id, mint_function_id, mint_data_stack) +``` +
+ +**Unlock** + +``` +v_option_contract_id = "" + +voption_contract_helper = VOptionContractHelper() + +unlock_function_id = VOptionContractHelper.unlock_function_index + +unlock_data_stack = voption_contract_helper.unlock_data_stack_generator() + +sender.execute_contract(v_option_contract_id, unlock_function_id, unlock_data_stack) +``` +
+ +**Execute** + +``` +v_option_contract_id = "" + +voption_contract_helper = VOptionContractHelper() + +execute_function_id = VOptionContractHelper.execute_function_index + +execute_data_stack = voption_contract_helper.execute_data_stack_generator( + +**Collect** + +``` +v_option_contract_id = "" + +voption_contract_helper = VOptionContractHelper() + +collect_function_id = VOptionContractHelper.collect_function_index + +collect_data_stack = voption_contract_helper.collect_data_stack_generator() + +minter.execute_contract(v_option_contract_id, collect_function_id, collect_data_stack) +``` +
+ +**Deposit the token into a contract** + +``` +token_V2_contract_id = "" + +token_V2_contract_helper = TokenV2ContractHelper() + +deposit_function_id = TokenV2ContractHelper.deposit_function_index + +deposit_data_stack = token_V2_contract_helper.deposit_data_stack_generator(depositer.address,'',) + +print(depositer.execute_contract(token_V2_contract_id, deposit_function_id, deposit_data_stack)) +``` +
+ + +**Withdraw the token from a contract** + +``` +token_V2_contract_id = "" + +token_V2_contract_helper = TokenV2ContractHelper() + +withdraw_function_id = TokenV2ContractHelper.withdraw_function_index + +withdraw_data_stack = token_V2_contract_helper.withdraw_data_stack_generator('', withdrawer.address, ) + +withdrawer.execute_contract(token_V2_contract_id, withdraw_function_id, withdraw_data_stack) +``` +
+ + +### Querying the Contract Database + +In order for the contract to do anything, it has to store some information within the database. This information can be queried by using the correct database key within the full node. The contract helper objects contain the corresponding database keys for each stored variable. + +### Insert Tables + +### Insert Tables + + +**Get the base token balance of the user in v option contract** + +``` +voption_contract_helper = VOptionContractHelper() + +v_option_contract_id = "" + +base_token_db_key = voption_contract_helper.base_token_balance_db_key_generator(
) + +print(chain.contract_db_query(v_option_contract_id, base_token_db_key)) +``` +
+ + +**Get the target token balance of the user in v option contract** + +``` +voption_contract_helper = VOptionContractHelper() + +v_option_contract_id = "" + +target_token_db_key = voption_contract_helper.target_token_balance_db_key_generator(
) + +print(chain.contract_db_query(v_option_contract_id, target_token_db_key)) +``` +
+ + +**Get the option token balance of the user in v option contract** + +``` +voption_contract_helper = VOptionContractHelper() + +v_option_contract_id = "" + +option_token_db_key = voption_contract_helper.option_token_balance_db_key_generator(
) + +print(chain.contract_db_query(v_option_contract_id, option_token_db_key)) +``` +
+ + +**Get the proof token balance of the user in v option contract** + +``` +voption_contract_helper = VOptionContractHelper() + +v_option_contract_id = "" + +proof_token_db_key = voption_contract_helper.proof_token_balance_db_key_generator(
) + +print(chain.contract_db_query(v_option_contract_id, proof_token_db_key)) +``` +
+ + + + diff --git a/src/docs/get-started/smart-contracts/vOptionContract.png b/src/docs/get-started/smart-contracts/vOptionContract.png new file mode 100644 index 000000000..555994d61 Binary files /dev/null and b/src/docs/get-started/smart-contracts/vOptionContract.png differ