Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Danenbm/merge main #159

Merged
merged 5 commits into from
Jul 2, 2024
Merged

Danenbm/merge main #159

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
5 commits
Select commit Hold shift + click to select a range
551ff6d
filter out collection fields not applicable on asset on derivation (#…
nhanphan Jun 20, 2024
7e6bea2
Deploy JS client v1.0.2
danenbm Jun 21, 2024
7de477b
Make JS README.md render correctly (#152)
mikemaccana Jul 1, 2024
3a8b45d
Do not run pre-commit during merge
danenbm Jul 2, 2024
9cb766d
Merge branch 'main' into danenbm/merge-main
danenbm Jul 2, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
5 changes: 5 additions & 0 deletions .husky/pre-commit
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,5 +1,10 @@
#!/bin/sh

# Exit if a merge is in progress
if [ -f .git/MERGE_HEAD ]; then
exit 0
fi

set +e

# Stash un-staged changes
Expand Down
267 changes: 133 additions & 134 deletions clients/js/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -38,146 +38,145 @@ A Umi-compatible JavaScript library for the project.
4. Examples
```ts
// Create an asset
const assetAddress = generateSigner(umi);
const owner = generateSigner(umi);

await create(umi, {
name: 'Test Asset',
uri: 'https://example.com/asset.json',
asset: assetAddress,
owner: owner.publicKey, // optional, will default to payer
}).sendAndConfirm(umi);

// Fetch an asset
const asset = await fetchAssetV1(umi, assetAddress.publicKey);

// Create a collection
const collectionUpdateAuthority = generateSigner(umi);
const collectionAddress = generateSigner(umi);
await createCollection(umi, {
name: 'Test Collection',
uri: 'https://example.com/collection.json',
collection: collectionAddress,
updateAuthority: collectionUpdateAuthority.publicKey, // optional, defaults to payer
}).sendAndConfirm(umi);

// Fetch a collection
const collection = await fetchCollectionV1(umi, collectionAddress.publicKey);

// Create an asset in a collection, the authority must be the updateAuthority of the collection
await create(umi, {
name: 'Test Asset',
uri: 'https://example.com/asset.json',
asset: assetAddress,
collection,
authority: collectionUpdateAuthority, // optional, defaults to payer
}).sendAndConfirm(umi);

// Transfer an asset
const recipient = generateSigner(umi);
await transfer(umi, {
asset,
newOwner: recipient.publicKey,
}).sendAndConfirm(umi);

// Transfer an asset in a collection
await transfer(umi, {
asset,
newOwner: recipient.publicKey,
collection,
}).sendAndConfirm(umi);

// GPA fetch assets by owner
const assetsByOwner = await getAssetV1GpaBuilder(umi)
.whereField('key', Key.AssetV1)
.whereField('owner', owner.publicKey)
.getDeserialized();

// GPA fetch assets by collection
const assetsByCollection = await getAssetV1GpaBuilder(umi)
.whereField('key', Key.AssetV1)
.whereField(
'updateAuthority',
updateAuthority('Collection', [collectionAddress.publicKey])
)
.getDeserialized();

// DAS API (RPC based indexing) fetch assets by owner/collection
// Coming soon
const assetAddress = generateSigner(umi);
const owner = generateSigner(umi);
await create(umi, {
name: 'Test Asset',
uri: 'https://example.com/asset.json',
asset: assetAddress,
owner: owner.publicKey, // optional, will default to payer
}).sendAndConfirm(umi);

// Fetch an asset
const asset = await fetchAssetV1(umi, assetAddress.publicKey);

// Create a collection
const collectionUpdateAuthority = generateSigner(umi);
const collectionAddress = generateSigner(umi);
await createCollection(umi, {
name: 'Test Collection',
uri: 'https://example.com/collection.json',
collection: collectionAddress,
updateAuthority: collectionUpdateAuthority.publicKey, // optional, defaults to payer
}).sendAndConfirm(umi);

// Fetch a collection
const collection = await fetchCollectionV1(umi, collectionAddress.publicKey);

// Create an asset in a collection, the authority must be the updateAuthority of the collection
await create(umi, {
name: 'Test Asset',
uri: 'https://example.com/asset.json',
asset: assetAddress,
collection,
authority: collectionUpdateAuthority, // optional, defaults to payer
}).sendAndConfirm(umi);

// Transfer an asset
const recipient = generateSigner(umi);
await transfer(umi, {
asset,
newOwner: recipient.publicKey,
}).sendAndConfirm(umi);

// Transfer an asset in a collection
await transfer(umi, {
asset,
newOwner: recipient.publicKey,
collection,
}).sendAndConfirm(umi);

// GPA fetch assets by owner
const assetsByOwner = await getAssetV1GpaBuilder(umi)
.whereField('key', Key.AssetV1)
.whereField('owner', owner.publicKey)
.getDeserialized();

// GPA fetch assets by collection
const assetsByCollection = await getAssetV1GpaBuilder(umi)
.whereField('key', Key.AssetV1)
.whereField(
'updateAuthority',
updateAuthority('Collection', [collectionAddress.publicKey])
)
.getDeserialized();

// DAS API (RPC based indexing) fetch assets by owner/collection
// Coming soon

```
5. Some advanced examples
```ts
const umi = await createUmi();

// Freezing an asset
const assetAddress = generateSigner(umi);
const freezeDelegate = generateSigner(umi);

await addPlugin(umi, {
asset: assetAddress.publicKey,
// adds the owner-managed freeze plugin to the asset
plugin: {
type: 'FreezeDelegate',
frozen: true,

// Optionally set the authority to a delegate who can unfreeze. If unset, this will be the Owner
// This is functionally the same as calling addPlugin and approvePluginAuthority separately.
// Freezing with a delegate is commonly used for escrowless staking programs.
authority: {
type: 'Address',
address: freezeDelegate.publicKey,
},
}
}).sendAndConfirm(umi);

// Unfreezing an asset with a delegate
// Revoking an authority will revert the authority back to the owner for owner-managed plugins
await revokePluginAuthority(umi, {
asset: assetAddress.publicKey,
plugin: {
type: 'FreezeDelegate',
},
authority: freezeDelegate,
}).sendAndConfirm(umi);

// Create a collection with royalties
const collectionAddress = generateSigner(umi);
const creator1 = generateSigner(umi);
const creator2 = generateSigner(umi);

await createCollection(umi, {
name: 'Test Collection',
uri: 'https://example.com/collection.json',
collection: collectionAddress,
plugins: [
{
type: 'Royalties',
basisPoints: 500,
creators: [
{
address: creator1.publicKey,
percentage: 20,
},
{
address: creator2.publicKey,
percentage: 80,
},
],
ruleSet: ruleSet('None'), // Compatibility rule set

},
],
}).sendAndConfirm(umi);

// Create an asset in a collection.
// Assets in a collection will inherit the collection's authority-managed plugins, in this case the royalties plugin
await create(umi, {
name: 'Test Asset',
uri: 'https://example.com/asset.json',
asset: assetAddress,
collection: await fetchCollectionV1(umi, collectionAddress.publicKey),
}).sendAndConfirm(umi);
// Freezing an asset
const assetAddress = generateSigner(umi);
const freezeDelegate = generateSigner(umi);

await addPlugin(umi, {
asset: assetAddress.publicKey,
// adds the owner-managed freeze plugin to the asset
plugin: {
type: 'FreezeDelegate',
frozen: true,
// Optionally set the authority to a delegate who can unfreeze. If unset, this will be the Owner
// This is functionally the same as calling addPlugin and approvePluginAuthority separately.
// Freezing with a delegate is commonly used for escrowless staking programs.
authority: {
type: 'Address',
address: freezeDelegate.publicKey,
},
}
}).sendAndConfirm(umi);

// Unfreezing an asset with a delegate
// Revoking an authority will revert the authority back to the owner for owner-managed plugins
await revokePluginAuthority(umi, {
asset: assetAddress.publicKey,
plugin: {
type: 'FreezeDelegate',
},
authority: freezeDelegate,
}).sendAndConfirm(umi);

// Create a collection with royalties
const collectionAddress = generateSigner(umi);
const creator1 = generateSigner(umi);
const creator2 = generateSigner(umi);

await createCollection(umi, {
name: 'Test Collection',
uri: 'https://example.com/collection.json',
collection: collectionAddress,
plugins: [
{
type: 'Royalties',
basisPoints: 500,
creators: [
{
address: creator1.publicKey,
percentage: 20,
},
{
address: creator2.publicKey,
percentage: 80,
},
],
ruleSet: ruleSet('None'), // Compatibility rule set

},
],
}).sendAndConfirm(umi);

// Create an asset in a collection.
// Assets in a collection will inherit the collection's authority-managed plugins, in this case the royalties plugin
await create(umi, {
name: 'Test Asset',
uri: 'https://example.com/asset.json',
asset: assetAddress,
collection: await fetchCollectionV1(umi, collectionAddress.publicKey),
}).sendAndConfirm(umi);
```

You can learn more about this library's API by reading its generated [TypeDoc documentation](https://mpl-core-js-docs.vercel.app).
Expand Down
Loading