ARCHIVE/xrpl-dev-portal
1
0
Fork 0
mirror of https://github.com/XRPLF/xrpl-dev-portal.git synced 2025-11-22 20:55:50 +00:00
Code Issues Packages Projects Releases Wiki Activity

Merge branch 'py-condition-escrow' of github.com:XRPLF/xrpl-dev-portal into py-condition-escrow

Browse Source 
Sync with current version.
This commit is contained in:
ddawson
2023-10-23 12:26:52 -07:00
parent 0620dfbbeb 54b412ef1a
commit f46ec100ac
268 changed files with 3340 additions and 1647 deletions
Download Patch File Download Diff File Expand all files Collapse all files

1
content/tutorials/get-started/get-started-using-python.md
View File

@@ -94,6 +94,7 @@ This method returns a [`Wallet` instance](https://xrpl-py.readthedocs.io/en/late
print(test_wallet)
# print output
public_key:: 022FA613294CD13FFEA759D0185007DBE763331910509EF8F1635B4F84FA08AEE3
private_key:: -HIDDEN-
classic_address: raaFKKmgf6CRZttTVABeTcsqzRQ51bNR6Q

9
content/tutorials/http-websocket-apis/index.md Normal file
View File

@@ -0,0 +1,9 @@
---
html: http-websocket-apis-tutorials.html
parent: tutorials.html
top_nav_grouping: Article Types
template: pagetype-category.html.jinja
---
# HTTP / Websocket APIs
XRPL tutorials for HTTP / Websocket APIs.

9
content/tutorials/java/index.md Normal file
View File

@@ -0,0 +1,9 @@
---
html: java.html
parent: tutorials.html
top_nav_grouping: Article Types
template: pagetype-category.html.jinja
---
# Java
XRPL tutorials in Java.

9
content/tutorials/javascript/index.md Normal file
View File

@@ -0,0 +1,9 @@
---
html: javascript.html
parent: tutorials.html
top_nav_grouping: Article Types
template: pagetype-category.html.jinja
---
# JavaScript
XRPL tutorials in JavaScript.

9
content/tutorials/javascript/modular-tutorials-in-javascript/index.md Normal file
View File

@@ -0,0 +1,9 @@
---
html: modular-tutorials-in-javascript.html
parent: javascript.html
top_nav_grouping: Article Types
template: pagetype-category.html.jinja
---
# Modular Tutorials in JavaScript
Modular XRPL tutorials in JavaScript.

9
content/tutorials/javascript/modular-tutorials-in-javascript/nfts-using-javascript/index.md Normal file
View File

@@ -0,0 +1,9 @@
---
html: nfts-using-javascript.html
parent: modular-tutorials-in-javascript.html
top_nav_grouping: Article Types
template: pagetype-category.html.jinja
---
# NFTs Using JavaScript
Mint and sell NFTs on the XRP Ledger using JavaScript.

9
content/tutorials/python/index.md Normal file
View File

@@ -0,0 +1,9 @@
---
html: python.html
parent: tutorials.html
top_nav_grouping: Article Types
template: pagetype-category.html.jinja
---
# Python
XRPL tutorials in Python.

10
content/tutorials/python/modular-tutorials-in-python/index.md Normal file
View File

@@ -0,0 +1,10 @@
---
html: modular-tutorials-in-python.html
parent: python.html
top_nav_grouping: Article Types
template: pagetype-category.html.jinja
blurb: Modular XRPL tutorials in Python.
---
# Modular Tutorials in Python
These tutorials take an incremental approach to implementing functionality, so you can reuse parts from the earlier tutorials on your way to making more advanced software.

10
content/tutorials/python/modular-tutorials-in-python/nfts-using-python/index.md Normal file
View File

@@ -0,0 +1,10 @@
---
html: nfts-using-python.html
parent: modular-tutorials-in-python.html
top_nav_grouping: Article Types
template: pagetype-category.html.jinja
blurb: Mint and sell NFTs on the XRP Ledger using Python.
---
# NFTs Using Python
Mint and sell NFTs on the XRP Ledger using Python.

76
content/tutorials/quickstart/py-batch-minting.md
View File

@@ -1,6 +1,6 @@
---
html: py-batch-minting.html
parent: quickstart-python.html
parent: nfts-using-python.html
blurb: Mint multiple NFTs with the press of a button.
labels:
- Accounts
@@ -28,20 +28,26 @@ You can download or clone the [Quickstart Samples](https://github.com/XRPLF/xrpl
1. If you want to use an existing account seed:
1. Paste the account seed in the **Standby Seed** field.
2. Click **Get Standby Account**.
2. If you do not want to use an existing account seed, click **Get Standby Account**.
2. If you do not want to use an existing account seed, just click **Get Standby Account**.
3. Click **Get Standby Account Info** to get the current XRP balance.
## Batch Mint NFTs
<div align="center">
<iframe width="560" height="315" src="https://www.youtube.com/embed/NjEqEWcqhwc?si=E8ws75gts_7TtOuU" title="YouTube video player" frameborder="0" allow="accelerometer; autoplay; clipboard-write; encrypted-media; gyroscope; picture-in-picture; web-share" allowfullscreen></iframe>
</div>
This example lets you mint multiple NFTs for a single unique item. The NFT might represent "prints" of an original artwork, tickets to an event, or another limited set of unique items.
To batch mint non-fungible token objects:
1. Set the **Flags** field. For testing purposes, we recommend setting the value to _8_. This sets the _tsTransferable_ flag, meaning that the NFT object can be transferred to another account. Otherwise, the NFT object can only be transferred back to the issuing account. See [NFTokenMint](nftokenmint.html) for available NFT minting flags.
2. Enter the **NFT URI**. This is a URI that points to the data or metadata associated with the NFT object. You can use the sample URI provided if you do not have one of your own.
3. Enter an **NFT Count** of up to 200 NFTs to create in one batch.
4. Enter the **Transfer Fee**, a percentage of the proceeds that the original creator receives from future sales of the NFT. This is a value of 0-50000 inclusive, allowing transfer fees between 0.000% and 50.000% in increments of 0.001%. If you do not set the **Flags** field to allow the NFT to be transferrable, set this field to 0.
5. Click **Batch Mint NFTs**.
1. Enter the **NFT URI**. This is a URI that points to the data or metadata associated with the NFT object. You can use this sample URI if you do not have one of your own: ipfs://bafybeigdyrzt5sfp7udm7hu76uh7y26nf4dfuylqabf3oclgtqy55fbzdi.
2. Set the **Flags** field. For testing purposes, we recommend setting the value to _8_. This sets the _tsTransferable_ flag, meaning that the NFT object can be transferred to another account. Otherwise, the NFT object can only be transferred back to the issuing account. See [NFTokenMint](nftokenmint.html) for available NFT minting flags.
3. Enter the **Transfer Fee**, a percentage of the proceeds that the original creator receives from future sales of the NFT. This is a value of 0-50000 inclusive, allowing transfer fees between 0.000% and 50.000% in increments of 0.001%. If you do not set the **Flags** field to allow the NFT to be transferrable, set this field to 0.
4. Enter the **Taxon** for the NFT. If you do not have a need for the Taxon field, set this value to 0.
5. Enter an **NFT Count** of up to 200 NFTs to create in one batch.
6. Click **Batch Mint NFTs**.
## Get Batch NFTs
@@ -235,11 +241,7 @@ import tkinter as tk
import xrpl
import json
from mod1 import get_account, get_account_info, send_xrp
from mod2 import (
get_balance,
configure_account,
)
from mod1 import get_account, get_account_info
```
Import dependencies from `mod7.py`.
@@ -265,17 +267,11 @@ def batch_mint_nfts():
text_standby_results.delete("1.0", tk.END)
text_standby_results.insert("1.0", json.dumps(results, indent=4))
def get_batch_nfts():
results = get_batch(ent_standby_seed.get(), ent_standby_account.get())
text_standby_results.delete("1.0", tk.END)
text_standby_results.insert("1.0",json.dumps(results, indent=4))
# Module 2 Handlers
def standby_configure_account():
results = configure_account(
def standby_get_batch_nfts():
results = get_batch(
ent_standby_seed.get(),
standbyRippling)
ent_standby_account.get()
)
text_standby_results.delete("1.0", tk.END)
text_standby_results.insert("1.0", json.dumps(results, indent=4))
@@ -298,12 +294,10 @@ def get_standby_account_info():
Rename the window for Module 7.
```python
# Create a new window with the title "Quickstart Module 7"
# Create a new window with the title "Python Module - Batch Minting"
window = tk.Tk()
window.title("Quickstart Module 7")
window.title("Python Module - Batch Minting")
standbyRippling = tk.BooleanVar()
operationalRippling = tk.BooleanVar()
# Form frame
@@ -315,11 +309,8 @@ lbl_standy_seed = tk.Label(master=frm_form, text="Standby Seed")
ent_standby_seed = tk.Entry(master=frm_form, width=50)
lbl_standby_account = tk.Label(master=frm_form, text="Standby Account")
ent_standby_account = tk.Entry(master=frm_form, width=50)
lbl_standy_amount = tk.Label(master=frm_form, text="Amount")
ent_standby_amount = tk.Entry(master=frm_form, width=50)
lbl_standby_balance = tk.Label(master=frm_form, text="XRP Balance")
ent_standby_balance = tk.Entry(master=frm_form, width=50)
cb_standby_allow_rippling = tk.Checkbutton(master=frm_form, text="Allow Rippling", variable=standbyRippling, onvalue=True, offvalue=False)
lbl_standby_uri = tk.Label(master=frm_form, text="NFT URI")
ent_standby_uri = tk.Entry(master=frm_form, width=50)
lbl_standby_flags = tk.Label(master=frm_form, text="Flags")
@@ -330,6 +321,8 @@ lbl_standby_taxon = tk.Label(master=frm_form, text="Taxon")
ent_standby_taxon = tk.Entry(master=frm_form, width="50")
lbl_standby_nft_id = tk.Label(master=frm_form, text="NFT ID")
ent_standby_nft_id = tk.Entry(master=frm_form, width="50")
lbl_standby_nft_offer_index = tk.Label(master=frm_form, text="NFT Offer Index")
ent_standby_nft_offer_index = tk.Entry(master=frm_form, width="50")
```
Add the **NFT Count** field for batch minting.
@@ -345,11 +338,8 @@ lbl_standy_seed.grid(row=0, column=0, sticky="w")
ent_standby_seed.grid(row=0, column=1)
lbl_standby_account.grid(row=2, column=0, sticky="e")
ent_standby_account.grid(row=2, column=1)
lbl_standy_amount.grid(row=3, column=0, sticky="e")
ent_standby_amount.grid(row=3, column=1)
lbl_standby_balance.grid(row=5, column=0, sticky="e")
ent_standby_balance.grid(row=5, column=1)
cb_standby_allow_rippling.grid(row=7,column=1, sticky="w")
lbl_standby_uri.grid(row=8, column=0, sticky="e")
ent_standby_uri.grid(row=8, column=1, sticky="w")
lbl_standby_flags.grid(row=9, column=0, sticky="e")
@@ -358,8 +348,6 @@ lbl_standby_transfer_fee.grid(row=10, column=0, sticky="e")
ent_standby_transfer_fee.grid(row=10, column=1, sticky="w")
lbl_standby_taxon.grid(row=11, column=0, sticky="e")
ent_standby_taxon.grid(row=11, column=1, sticky="w")
lbl_standby_nft_id.grid(row=12, column=0, sticky="e")
ent_standby_nft_id.grid(row=12, column=1, sticky="w")
```
Place the **NFT Count** field in the grid.
@@ -369,7 +357,6 @@ lbl_standby_nft_count.grid(row=13, column=0, sticky="e")
ent_standby_nft_count.grid(row=13, column=1, sticky="w")
lbl_standby_results.grid(row=14, column=0, sticky="ne")
text_standby_results.grid(row=14, column=1, sticky="nw")
cb_standby_allow_rippling.select()
#############################################
## Buttons ##################################
@@ -383,22 +370,19 @@ btn_get_standby_account_info = tk.Button(master=frm_form,
text="Get Standby Account Info",
command = get_standby_account_info)
btn_get_standby_account_info.grid(row=1, column=2, sticky = "nsew")
btn_standby_configure_account = tk.Button(master=frm_form,
text="Configure Account",
command = standby_configure_account)
btn_standby_configure_account.grid(row=7,column=0, sticky = "nsew")
```
Add the **Batch Mint NFTs** and **Get Batch NFTs** buttons.
```python
btn_standby_mint_token = tk.Button(master=frm_form, text="Batch Mint NFTs",
command = batch_mint_nfts)
btn_standby_mint_token.grid(row=8, column=2, sticky="nsew")
btn_standby_get_tokens = tk.Button(master=frm_form, text="Get Batch NFTs",
command = get_batch_nfts)
btn_standby_get_tokens.grid(row=9, column=2, sticky="nsew")
btn_standby_batch_mint = tk.Button(master=frm_form,
text="Batch Mint NFTs",
command = standby_batch_mint)
btn_standby_batch_mint.grid(row=5, column=2, sticky = "nsew")
btn_standby_get_batch_nfts = tk.Button(master=frm_form,
text="Get Batch NFTs",
command = standby_get_batch_nfts)
btn_standby_get_batch_nfts.grid(row=8, column=2, sticky = "nsew")
# Start the application
window.mainloop()

12
content/tutorials/quickstart/py-transfer-nfts.md
View File

@@ -551,7 +551,7 @@ def standby_cancel_offer():
ent_standby_nft_offer_index.get()
)
text_standby_results.delete("1.0", tk.END)
text_standby_results.insert("1.0", json.dumps(results, indent=4))
text_standby_results.insert("1.0", json.dumps(results, indent=4))
def op_create_sell_offer():
results = create_sell_offer(
ent_operational_seed.get(),
@@ -579,7 +579,7 @@ def op_create_buy_offer():
ent_operational_destination.get()
)
text_operational_results.delete("1.0", tk.END)
text_operational_results.insert("1.0", json.dumps(results, indent=4))
text_operational_results.insert("1.0", json.dumps(results, indent=4))
def op_accept_buy_offer():
results = accept_buy_offer (
ent_operational_seed.get(),
@@ -597,7 +597,7 @@ def op_cancel_offer():
ent_operational_nft_offer_index.get()
)
text_operational_results.delete("1.0", tk.END)
text_operational_results.insert("1.0", json.dumps(results, indent=4))
text_operational_results.insert("1.0", json.dumps(results, indent=4))
# Module 3 Handlers
@@ -690,10 +690,10 @@ def operational_configure_account():
def get_balances():
results = get_balance(ent_operational_account.get(), ent_standby_account.get())
text_standby_results.delete("1.0", tk.END)
text_standby_results.insert("1.0", json.dumps(results, indent=4))
text_standby_results.insert("1.0", json.dumps(results, indent=4))
results = get_balance(ent_standby_account.get(), ent_operational_account.get())
text_operational_results.delete("1.0", tk.END)
text_operational_results.insert("1.0", json.dumps(results, indent=4))
text_operational_results.insert("1.0", json.dumps(results, indent=4))
# Module 1 Handlers
def get_standby_account():
@@ -996,7 +996,7 @@ btn_op_burn_token = tk.Button(master=frm_form, text="Burn NFT",
btn_op_burn_token.grid(row=10, column=3, sticky="nsew")
```
Add buttons for transferring NFTs.
Add buttons for transferring NFTs.
```python
btn_op_create_sell_offer = tk.Button(master=frm_form, text="Create Sell Offer",

9
content/tutorials/tasks/index.md Normal file
View File

@@ -0,0 +1,9 @@
---
html: tasks.html
parent: tutorials.html
top_nav_grouping: Article Types
template: pagetype-category.html.jinja
---
# Tasks
Common tasks on the XRP Ledger.

8
content/tutorials/tasks/manage-account-settings/index.md Normal file
View File

@@ -0,0 +1,8 @@
---
html: manage-account-settings.html
parent: tasks.html
template: pagetype-category.html.jinja
---
# Manage Account Settings
Set up your XRP Ledger account to send and receive payments the way you want it to.

8
content/tutorials/tasks/use-specialized-payment-types/index.md Normal file
View File

@@ -0,0 +1,8 @@
---
html: use-specialized-payment-types.html
parent: tasks.html
template: pagetype-category.html.jinja
---
# Use Specialized Payment Types
Use advanced features like Escrow and Payment Channels to build smart applications on the XRP Ledger.

8
content/tutorials/tasks/use-specialized-payment-types/use-escrows/index.md Normal file
View File

@@ -0,0 +1,8 @@
---
html: use-escrows.html
parent: use-specialized-payment-types.html
template: pagetype-category.html.jinja
---
# Use Escrows
The XRP Ledger supports escrows that can be executed only after a certain time has passed or a cryptographic condition has been fulfilled. Escrows can only send XRP, not issued currencies.

8
content/tutorials/tasks/use-tokens/index.md Normal file
View File

@@ -0,0 +1,8 @@
---
html: use-tokens.html
parent: tasks.html
template: pagetype-category.html.jinja
---
# Use Tokens
Create and trade tokens (fungible or otherwise) in the XRP Ledger.

4
content/tutorials/use-specialized-payment-types/use-escrows/send-a-time-held-escrow.md
View File

@@ -228,6 +228,6 @@ Response:
- [Escrow ledger object](escrow-object.html)
<!--{# common link defs #}-->
{% include '_snippets/rippled-api-links.md' %}
{% include '_snippets/tx-type-links.md' %}
{% include '_snippets/rippled-api-links.md' %}
{% include '_snippets/tx-type-links.md' %}
{% include '_snippets/rippled_versions.md' %}

1
content/tutorials/use-tokens/create-an-automated-market-maker.md
View File

@@ -11,6 +11,7 @@ labels:
- AMM
---
# Create an Automated Market Maker
_(Requires the [AMM amendment][] :not_enabled:)_
An [Automated Market Maker (AMM)](automated-market-makers.html) can be an efficient way to facilitate exchanges between two assets while earning its liquidity providers passive income. This tutorial shows how to create an AMM for a given asset pair.