You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: api-reference/overview/authentication.mdx
+22-10Lines changed: 22 additions & 10 deletions
Original file line number
Diff line number
Diff line change
@@ -4,15 +4,21 @@ description: "Learn more about Livepeer's API."
4
4
icon: "lock"
5
5
---
6
6
7
-
Livepeer API uses API keys to verify and authorize requests. You can manage and review your API keys through Livepeer Studio. You need to pass your API key in the `Authorization` header with a `Bearer` prefix while sending a request.
7
+
Livepeer API uses API keys to verify and authorize requests. You can manage and
8
+
review your API keys through Livepeer Studio. You need to pass your API key in
9
+
the `Authorization` header with a `Bearer` prefix while sending a request.
8
10
9
11
```
10
12
Bearer YOUR_API_KEY
11
13
```
12
14
13
-
It's important to note that your API keys come with significant privileges, so it's essential to keep them safe and secure! Refrain from sharing your secret API keys in GitHub or other publicly accessible places.
15
+
It's important to note that your API keys come with significant privileges, so
16
+
it's essential to keep them safe and secure! Refrain from sharing your secret
17
+
API keys in GitHub or other publicly accessible places.
14
18
15
-
By default, API keys can only be used from a backend server. This is to ensure maximum security and prevent that you accidentally expose your account by including the secret API key in a public web page.
19
+
By default, API keys can only be used from a backend server. This is to ensure
20
+
maximum security and prevent that you accidentally expose your account by
21
+
including the secret API key in a public web page.
16
22
17
23
### CORS-Enabled Keys
18
24
@@ -21,16 +27,22 @@ By default, API keys can only be used from a backend server. This is to ensure m
21
27
API keys. **There is a different security model for CORS keys.**
22
28
</Warning>
23
29
24
-
Studio supports the creation of CORS-enabled API keys. This is a special option when generating an API key which allows a webpage to make requests **directly**
30
+
Studio supports the creation of CORS-enabled API keys. This is a special option
31
+
when generating an API key which allows a webpage to make requests **directly**
25
32
to Studio, as opposed to coming from your backend.
26
33
27
34
#### Security with CORS Keys
28
35
29
-
**The security model is different for CORS-enabled API keys.** Since any user has access to these keys, the IDs of assets and streams **must** be kept
30
-
secret from anyone who should not have admin control over them. For instance, a viewer should only have access to the playback ID, since
31
-
knowing the asset ID (together with the CORS-enabled API key, which is embedded in the webpage) allows them to make changes to the asset.
32
-
33
-
This is the same for streams - if a user has access to a stream ID alongside the CORS API key, they can modify the stream or view the stream key.
34
-
If a viewer had access to the stream ID + CORS API key, they could hijack the stream. **A `playbackId` should be exposed to the viewer only.**
36
+
**The security model is different for CORS-enabled API keys.** Since any user
37
+
has access to these keys, the IDs of assets and streams **must** be kept secret
38
+
from anyone who should not have admin control over them. For instance, a viewer
39
+
should only have access to the playback ID, since knowing the asset ID (together
40
+
with the CORS-enabled API key, which is embedded in the webpage) allows them to
41
+
make changes to the asset.
42
+
43
+
This is the same for streams - if a user has access to a stream ID alongside the
44
+
CORS API key, they can modify the stream or view the stream key. If a viewer had
45
+
access to the stream ID + CORS API key, they could hijack the stream. **A
46
+
`playbackId` should be exposed to the viewer only.**
35
47
36
48
<Frame></Frame>
Copy file name to clipboardExpand all lines: api-reference/overview/introduction.mdx
+6-2Lines changed: 6 additions & 2 deletions
Original file line number
Diff line number
Diff line change
@@ -4,6 +4,10 @@ description: "Learn more about Livepeer's API."
4
4
icon: "hand-wave"
5
5
---
6
6
7
-
Welcome to the Livepeer API reference docs! Here you'll find all the endpoints exposed on the standard Livepeer API, learn how to use them and what they return.
7
+
Welcome to the Livepeer API reference docs! Here you'll find all the endpoints
8
+
exposed on the standard Livepeer API, learn how to use them and what they
9
+
return.
8
10
9
-
The Livepeer API is organized around REST, has predictable resource-oriented URLs, accepts form-encoded request bodies, returns JSON-encoded responses, and uses standard HTTP response codes, authentication, and verbs.
11
+
The Livepeer API is organized around REST, has predictable resource-oriented
12
+
URLs, accepts form-encoded request bodies, returns JSON-encoded responses, and
13
+
uses standard HTTP response codes, authentication, and verbs.
Copy file name to clipboardExpand all lines: delegators/guides/bridge-lpt-to-arbitrum.mdx
+55-18Lines changed: 55 additions & 18 deletions
Original file line number
Diff line number
Diff line change
@@ -3,14 +3,21 @@ title: Bridge LPT to Arbitrum
3
3
icon: bridge
4
4
---
5
5
6
-
This guide will walk tokenholders through the process of moving LPT from the Ethereum mainnet to Arbitrum and vice versa.
6
+
This guide will walk tokenholders through the process of moving LPT from the
7
+
Ethereum mainnet to Arbitrum and vice versa.
7
8
8
-
**This only applies if you have not delegated your LPT to an orchestrator on L1**
9
+
**This only applies if you have not delegated your LPT to an orchestrator on
10
+
L1**
9
11
10
-
Please note that you will need some ETH in your wallet to complete this guide. If you are using testnet, you will need Rinkeby ETH.
12
+
Please note that you will need some ETH in your wallet to complete this guide.
13
+
If you are using testnet, you will need Rinkeby ETH.
11
14
12
-
1. Make sure your wallet (i.e. Metamask) is connected to the Ethereum mainnet (Rinkeby if using testnet) and then navigate to the [Arbitrum Bridge](https://bridge.arbitrum.io/)
13
-
2. Click "Token", and enter the L1 LPT contract address 0x58b6a8a3302369daec383334672404ee733ab239. If you are using testnet, use the `LivepeerToken` address for Rinkeby.
15
+
1. Make sure your wallet (i.e. Metamask) is connected to the Ethereum mainnet
16
+
(Rinkeby if using testnet) and then navigate to the
17
+
[Arbitrum Bridge](https://bridge.arbitrum.io/)
18
+
2. Click "Token", and enter the L1 LPT contract address
19
+
0x58b6a8a3302369daec383334672404ee733ab239. If you are using testnet, use the
6. Select LPT from the dropdown. Once you've done this, you should see your L1 balance.
26
-
7. Click `Deposit` to move your L1 LPT to L2. This will initiate an Approval transaction. The first of 2 transactions required to bridge LPT to Arbitrum.
27
-
8. After the Approval transaction status changes from pending to success (about 10 mins) LPT can now be Deposited.
32
+
6. Select LPT from the dropdown. Once you've done this, you should see your L1
33
+
balance.
34
+
7. Click `Deposit` to move your L1 LPT to L2. This will initiate an Approval
35
+
transaction. The first of 2 transactions required to bridge LPT to Arbitrum.
36
+
8. After the Approval transaction status changes from pending to success (about
@@ -40,24 +51,50 @@ Please note that you will need some ETH in your wallet to complete this guide. I
40
51
41
52
The same general instructions apply with three differences:
42
53
43
-
- You should start with your wallet connected to Arbitrum (Arbitrum Rinkeby if using testnet)
44
-
- You will need to manually approve the amount that you are bridging using the [Arbiscan UI](https://arbiscan.io/address/0x289ba1701C2F088cf0faf8B3705246331cB8A839#writeContract). To do so, connect your wallet, scroll to the Approve function, enter the L2LPTGateway address [0x6D2457a4ad276000A615295f7A80F79E48CcD318](https://arbiscan.io/address/0x6D2457a4ad276000A615295f7A80F79E48CcD318) and the amount you'll be transferring and click "Write". Note that the amount is in "Wei", so use a [Unit Converter](https://etherscan.io/unitconverter) (e.g. if you want to bridge 10 LPT, you need to enter 10000000000000000000).
45
-
- We are looking into options to remove this step. If it seems complex, we recommend swapping to ETH via [Uniswap](https://app.uniswap.org/#/swap?chain=arbitrum) and then transferring the ETH from L2 to L1 instead.
46
-
- Next, click on the arrow below the amount input. The button will switch from "Deposit" to "Withdraw"
47
-
- Click on "Token" -> "Manage token lists" -> enable "Arbed CMC List" and click on "Back to Select Token". You should now be able to choose LPT in the list.
48
-
- After you've sent the withdraw tx, you need to wait ~1 week until you can claim your LPT on L1. You'll see the countdown below. Once the confirmation period is over, you can connect to the Ethereum mainnet and click "Claim" to withdraw your LPT on L1.
54
+
- You should start with your wallet connected to Arbitrum (Arbitrum Rinkeby if
55
+
using testnet)
56
+
- You will need to manually approve the amount that you are bridging using the
and the amount you'll be transferring and click "Write". Note that the amount
62
+
is in "Wei", so use a [Unit Converter](https://etherscan.io/unitconverter)
63
+
(e.g. if you want to bridge 10 LPT, you need to enter 10000000000000000000).
64
+
- We are looking into options to remove this step. If it seems complex, we
65
+
recommend swapping to ETH via
66
+
[Uniswap](https://app.uniswap.org/#/swap?chain=arbitrum) and then
67
+
transferring the ETH from L2 to L1 instead.
68
+
- Next, click on the arrow below the amount input. The button will switch from
69
+
"Deposit" to "Withdraw"
70
+
- Click on "Token" -> "Manage token lists" -> enable "Arbed CMC List" and click
71
+
on "Back to Select Token". You should now be able to choose LPT in the list.
72
+
- After you've sent the withdraw tx, you need to wait ~1 week until you can
73
+
claim your LPT on L1. You'll see the countdown below. Once the confirmation
74
+
period is over, you can connect to the Ethereum mainnet and click "Claim" to
75
+
withdraw your LPT on L1.
49
76
50
77
### Bridging Failures
51
78
52
-
The Arbitrum rollup can fail to bridge tokens correctly if the gas prices are fluctuating by too much, or if the transaction runs out of gas. The former can be caused by gas prices changing from when the original "bridge" transaction was submitted, to when it was sequenced and submitted on L2. In this case, tokens will not reach your L2 wallet after an hour. Arbitrum [provides a page](https://retryable-tx-panel.arbitrum.io/) to check on the status of your L1 deposit transaction:
79
+
The Arbitrum rollup can fail to bridge tokens correctly if the gas prices are
80
+
fluctuating by too much, or if the transaction runs out of gas. The former can
81
+
be caused by gas prices changing from when the original "bridge" transaction was
82
+
submitted, to when it was sequenced and submitted on L2. In this case, tokens
83
+
will not reach your L2 wallet after an hour. Arbitrum
84
+
[provides a page](https://retryable-tx-panel.arbitrum.io/) to check on the
You should then be able to connect your wallet and resubmit the bridge transaction. This will retry the previous transaction. Make sure to do this in a timely manner, since the [L2 retry buffer is limited](https://docs.arbitrum.io/arbos/l1-to-l2-messaging).
97
+
You should then be able to connect your wallet and resubmit the bridge
98
+
transaction. This will retry the previous transaction. Make sure to do this in a
99
+
timely manner, since the
100
+
[L2 retry buffer is limited](https://docs.arbitrum.io/arbos/l1-to-l2-messaging).
Copy file name to clipboardExpand all lines: delegators/guides/migrate-stake-to-arbitrum.mdx
+23-7Lines changed: 23 additions & 7 deletions
Original file line number
Diff line number
Diff line change
@@ -3,7 +3,10 @@ title: Migrate stake to Arbitrum
3
3
icon: right-from-bracket
4
4
---
5
5
6
-
This guide is applicable to delegators who delegated their LPT to an orchestrator on the Ethereum mainnet prior to February 14th, 2022. Once you have successfully completed the migration, this guide is no longer applicable and you will use Arbitrum in lieu of Ethereum Mainnet for all protocol actions.
6
+
This guide is applicable to delegators who delegated their LPT to an
7
+
orchestrator on the Ethereum mainnet prior to February 14th, 2022. Once you have
8
+
successfully completed the migration, this guide is no longer applicable and you
9
+
will use Arbitrum in lieu of Ethereum Mainnet for all protocol actions.
7
10
8
11
<Warning>
9
12
Claiming your delegated stake and earned ETH on Arbitrum is highly encouraged
@@ -16,13 +19,22 @@ This guide is applicable to delegators who delegated their LPT to an orchestrato
16
19
17
20
## Prerequisites for all chains
18
21
19
-
- Before using this guide, you will need make sure your Arbitrum wallet has enough arbETH to cover gas for the `claim` transaction. If you do not have arbETH in your wallet, you will need to add some using one of the bridges or on-ramps listed [here](https://portal.arbitrum.one/).
22
+
- Before using this guide, you will need make sure your Arbitrum wallet has
23
+
enough arbETH to cover gas for the `claim` transaction. If you do not have
24
+
arbETH in your wallet, you will need to add some using one of the bridges or
- The migration must be completed using the Livepeer explorer
21
-
-**If you use a contract account rather than an EOA**: You will need to interact directly with the Migrator contract methods. Please use the guide [here](/orchestrators/guides/migrate-from-contract-wallet). _If you don’t know what this means, it probably doesn’t apply to you._
27
+
-**If you use a contract account rather than an EOA**: You will need to
28
+
interact directly with the Migrator contract methods. Please use the guide
29
+
[here](/orchestrators/guides/migrate-from-contract-wallet). _If you don’t know
30
+
what this means, it probably doesn’t apply to you._
22
31
23
32
## Claiming via the Explorer
24
33
25
-
1. Navigate to the [Livepeer Explorer](http://explorer.livepeer.org). If you have not connected the wallet that you used to delegate your LPT, connect it using the prompt in the upper left hand corner. If you haven't switched your network to Arbitrum, you'll be prompted to do so.
34
+
1. Navigate to the [Livepeer Explorer](http://explorer.livepeer.org). If you
35
+
have not connected the wallet that you used to delegate your LPT, connect it
36
+
using the prompt in the upper left hand corner. If you haven't switched your
37
+
network to Arbitrum, you'll be prompted to do so.
26
38
27
39
<Frame>
28
40
<img
@@ -44,7 +56,8 @@ This guide is applicable to delegators who delegated their LPT to an orchestrato
44
56
45
57
2.**Claim your stake, rewards, and fees**
46
58
47
-
Click `Claim` to initiate a transaction that will claim your stake, rewards and fees.
59
+
Click `Claim` to initiate a transaction that will claim your stake, rewards
60
+
and fees.
48
61
49
62
<Frame>
50
63
<img
@@ -62,6 +75,9 @@ This guide is applicable to delegators who delegated their LPT to an orchestrato
62
75
63
76
3.**View your profile**
64
77
65
-
Once the `claim` transaction has been confirmed (this usually takes a few seconds on Arbitrum), you see a link to your profile. Here, you'll be able to see your newly claimed balances.
78
+
Once the `claim` transaction has been confirmed (this usually takes a few
79
+
seconds on Arbitrum), you see a link to your profile. Here, you'll be able
80
+
to see your newly claimed balances.
66
81
67
-
You will see an [Arbiscan](https://arbiscan.io/) link to the transaction id in case you want to look at the submitted transaction.
82
+
You will see an [Arbiscan](https://arbiscan.io/) link to the transaction id
83
+
in case you want to look at the submitted transaction.
0 commit comments