Skip to content

Commit 12f0eee

Browse files
committed
gas sponsorship doc improvement as it relates to deployment
1 parent 66b6aff commit 12f0eee

7 files changed

Lines changed: 46 additions & 6 deletions

File tree

solutions/builder/collections/quickstart.mdx

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -45,6 +45,9 @@ And complete your contract details, specifying the `Network`, `Contract Name`, a
4545
<Frame>
4646
![contract details](/images/collections/collections_deploy_contract.png)
4747
</Frame>
48+
<Warning>
49+
If you deploy from Builder on production networks, treat the deployment as self-funded. Gas Sponsorship can still be useful for relayed interactions after the contract is deployed, but the deployment transaction itself may still require the deploying wallet to pay gas.
50+
</Warning>
4851
Then you will notice if you check out the `Read Contract` section tab of the contract, if you `Read` from the `baseURI` it will show you the metadata url from Sequence where when read from the Indexer, `<token_id>.json` will get appended to the end to reference the json for the collectible.
4952
<Frame>
5053
![read base uri](/images/collections/collection_read_base_uri.png)

solutions/builder/contracts/deploy-ERC20-currency.mdx

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -68,6 +68,9 @@ Deploy your contract from the popup window at http://sequence.app/sign-transacti
6868
<Frame>
6969
<img src="/images/collectibles/sign_deploy_transaction.png" width="200" />
7070
</Frame>
71+
<Warning>
72+
On production networks, treat Builder deployments as self-funded. Even if you have configured Gas Sponsorship for related wallets or contracts, the wallet performing the deployment may still need enough native gas token to pay for the deployment transaction.
73+
</Warning>
7174
<Note>
7275

7376
All testnets will be free to transact on

solutions/builder/contracts/deploy-an-item-collection.mdx

Lines changed: 4 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -45,10 +45,13 @@ Then make your choice of Web3 Game Item Collection (ERC1155) or NFT Collection (
4545

4646
## Step 3: Specify contract details
4747

48-
Complete the contract details by specifying a `Contract Name` and `Owner` for your contract, with the option to input Royalties. Make sure the Owner address is the Sequence Wallet in the top-right hand corner and that you have funds in this wallet on mainnet, otherwise on testnet - we sponsor these transactions for you.
48+
Complete the contract details by specifying a `Contract Name` and `Owner` for your contract, with the option to input Royalties. Make sure the Owner address is the Sequence Wallet in the top-right hand corner and that you have funds in this wallet on production networks, otherwise on testnet - we sponsor these transactions for you.
4949
<Frame>
5050
![deploy game item](/images/collectibles/deploy_game_item.png)
5151
</Frame>
52+
<Warning>
53+
On production networks, treat Builder deployments as self-funded. Even if you have configured Gas Sponsorship for related wallets or contracts, the wallet performing the deployment may still need enough native gas token to pay for the deployment transaction.
54+
</Warning>
5255
<Note>
5356

5457
Note:

solutions/builder/contracts/deploy-primary-sales-contract.mdx

Lines changed: 8 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -9,6 +9,14 @@ sidebarTitle: Deploy a Primary Sales Contract
99

1010
This guide walks through how to setup and deploy the contracts for launching a primary sale - suitable for an NFT Drop, in-game store, and more.
1111

12+
<Warning>
13+
Current Builder behavior:
14+
15+
Treat Builder contract deployments as self-funded transactions on production networks. Even if you have configured Gas Sponsorship for related wallets or contracts, the wallet performing the deployment may still need enough native gas token to pay for deployment.
16+
17+
After the contracts are deployed, sponsorship can still be used for supported relayed interactions with those contracts.
18+
</Warning>
19+
1220
<Steps>
1321
<Step title="Step 1: Navigate to contracts">
1422

solutions/builder/contracts/deploy-soulbound-token.mdx

Lines changed: 4 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -37,11 +37,14 @@ Select either Web3 Game Item Collection (ERC1155) or NFT Collection (ERC721) for
3737

3838
## Step 3: Specify contract details
3939

40-
Provide details for the contract by specifying a `Contract Name` and `Owner`. You also have the option to set Royalties. Ensure that the Owner address matches the Sequence Wallet in the top-right corner, with adequate funds in this wallet on mainnet. For testnet transactions, we sponsor them for you.
40+
Provide details for the contract by specifying a `Contract Name` and `Owner`. You also have the option to set Royalties. Ensure that the Owner address matches the Sequence Wallet in the top-right corner, with adequate funds in this wallet on production networks. For testnet transactions, we sponsor them for you.
4141
<Frame>
4242
![deploy game item](/images/collectibles/deploy_game_item.png)
4343
</Frame>
4444
<Warning>
45+
On production networks, treat Builder deployments as self-funded. Even if you have configured Gas Sponsorship for related wallets or contracts, the wallet performing the deployment may still need enough native gas token to pay for the deployment transaction.
46+
</Warning>
47+
<Warning>
4548
Note:
4649
Changing the `name` later will update it across the Sequence stack, but popular explorers will not reindex the information. Your initial entry will remain in these systems.
4750
</Warning>

solutions/builder/contracts/overview.mdx

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -9,6 +9,12 @@ sidebarTitle: Overview
99

1010
Sequence Builder simplifies smart contract deployment and management with a suite of user-friendly features. Import, deploy, and add contract collaborators to a smart contract in the contracts dashboard and interact directly with your contract.
1111

12+
<Warning>
13+
On production networks, treat Builder contract deployments as self-funded transactions. Even if you have configured Gas Sponsorship for related wallets or contracts, the deploying wallet may still need enough native gas token to pay for the deployment transaction.
14+
15+
Gas Sponsorship is better thought of as support for relayed interactions after a contract is already deployed.
16+
</Warning>
17+
1218
##### What are my deployment options?
1319

1420
Deployment of contracts with Sequence Builder is simplified through a streamlined process directly within our dashboard. Choose from various contract templates (ERC1155, ERC721, ERC20). The Builder also gives you the option to upload your own custom contracts - saved to your project - and can be deployed directly to a network of your choosing.

solutions/builder/gas-sponsorship.mdx

Lines changed: 18 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -9,6 +9,16 @@ sidebarTitle: Gas Sponsorship
99

1010
When a user utilizes a Sequence wallet, we offer the compatibility of sponsoring gas on any chain for your users - either at the contract or address level. This means higher conversion rates to smooth the onboarding experience for your users. By default, Sequence sponsors all gas on testnets for a smooth developer experience, however we recommend when going to Mainnet that sponsor gas for your users.
1111

12+
<Warning>
13+
Current Builder behavior:
14+
15+
Treat Builder contract deployments on production networks as self-funded transactions. Even if you add a wallet or contract under Gas Sponsorship, deploying a new contract from Builder, including most factory-based deployments, may still require the deploying wallet to pay network gas.
16+
17+
Gas sponsorship is most reliable for relayed interactions with contracts that are already deployed.
18+
19+
Sponsoring a wallet address is broader than sponsoring a contract address. A sponsored wallet can cover relayed transactions from that wallet on the sponsored network beyond a single contract, while sponsoring a contract address is the narrower option.
20+
</Warning>
21+
1222
##### Why would I want to sponsor gas for my app?
1323

1424
Obtaining the crypto needed to cover gas fees poses a challenge for onboarding your users. Sponsoring gas on their behalf solves this problem, ultimately leading to higher conversion rates and retention.
@@ -25,7 +35,7 @@ To create a project, follow [this walkthrough](/solutions/builder/project-manage
2535
If you have a project already, sign in and select from the listed projects.
2636

2737
</Step>
28-
<Step title="Sponsor Contract Address">
38+
<Step title="Sponsor Wallet or Contract">
2939

3040
First, navigate to the [gas sponsorship overview page](https://sequence.build/project/default/relayer?view=overview).
3141

@@ -37,7 +47,9 @@ Or, `Add Contract` to select a smart contract that you'd like to sponsor.
3747
<Frame>
3848
![select relayer network](/images/builder/builder_gas_sponsoring_add_contract.png)
3949
</Frame>
40-
</Step>
50+
51+
Wallet sponsorship and contract sponsorship are scoped differently. Sponsoring a wallet can cover that wallet's relayed transactions across many contracts on the selected network. Sponsoring a contract can benefit many users, but only when they interact with that specific contract.
52+
</Step>
4153
<Step title="Add Payment & Configure">
4254

4355
Now, we are going to add a payment method via a credit card in order to fund the sponsorship. Go to the [gas sponsorship configuration](https://sequence.build/project/default/relayer?view=gas-tank) and select Setup Payment Method.
@@ -51,10 +63,12 @@ We will automatically notify you if your balance falls below $5 and you have spo
5163
</Step>
5264
<Step title="Test your Sponsorship">
5365

54-
We recommend testing out your sponsorships prior to launching. Simply call the contract or use your sponsored wallet for a mainnet transaction. You should shortly see the sponsored transactions list populating with these transactions - all gas free.
66+
We recommend testing out your sponsorships prior to launching. After the contract is already deployed, call the contract or use your sponsored wallet for a mainnet transaction. You should shortly see the sponsored transactions list populating with these transactions.
67+
68+
Do not use a Builder contract deployment as your sponsorship test, since deployment transactions may still require the deploying wallet to pay gas.
5569

5670
</Step>
5771
</Steps>
5872
## Ecosystem Gas Sponsorship
5973

60-
We also offer the capability to sponsor all transactions for your ecosystem where we orchestrate a number of signers through our relayer at the chain level. This means any developer building on your ecosystem as well as any user of Sequence wallets has the best onboarding and UX experience possible. Please feel free to [contact us](https://support.sequence.xyz) to set this up for your ecosystem.
74+
We also offer the capability to sponsor all transactions for your ecosystem where we orchestrate a number of signers through our relayer at the chain level. This means any developer building on your ecosystem as well as any user of Sequence wallets has the best onboarding and UX experience possible. Please feel free to [contact us](https://support.sequence.xyz) to set this up for your ecosystem.

0 commit comments

Comments
 (0)