Skip to main content
The PolygonClient provides methods to manage Polygon cryptocurrency accounts.

create()

Create a new Polygon account.
await bloque.accounts.polygon.create(
  params?: CreatePolygonAccountParams,
  options?: CreateAccountOptions
): Promise<PolygonAccount>

Parameters

params
CreatePolygonAccountParams
Polygon account creation parameters
options
CreateAccountOptions
Creation options

Returns

PolygonAccount
object

Example

// Create without waiting
const account = await bloque.accounts.polygon.create();

// Create and wait for active status
const account = await bloque.accounts.polygon.create({}, { waitLedger: true });

list()

List Polygon accounts.
await bloque.accounts.polygon.list(
  params?: ListPolygonAccountsParams
): Promise<ListPolygonAccountsResult>

Parameters

params
ListPolygonAccountsParams
List parameters

Returns

ListPolygonAccountsResult
object

Example

// List all polygon accounts
const result = await bloque.accounts.polygon.list();

// Get a specific polygon account
const result = await bloque.accounts.polygon.list({
  urn: 'did:bloque:account:polygon:0x05B10c9B6241b73fc8c906fB7979eFc7764AB731'
});

updateMetadata()

Update polygon account metadata.
await bloque.accounts.polygon.updateMetadata(
  params: UpdatePolygonMetadataParams
): Promise<PolygonAccount>

Parameters

params
UpdatePolygonMetadataParams
Metadata update parameters

Returns

PolygonAccount
object
Updated polygon account

Example

const account = await bloque.accounts.polygon.updateMetadata({
  urn: 'did:bloque:account:polygon:0x05B10c9B6241b73fc8c906fB7979eFc7764AB731',
  metadata: {
    updated_by: 'admin',
    update_reason: 'testing_update'
  }
});

activate()

Activate a Polygon account.
await bloque.accounts.polygon.activate(
  urn: string
): Promise<PolygonAccount>

Parameters

urn
string
required
Polygon account URN

Returns

PolygonAccount
object
Updated polygon account

Example

const account = await bloque.accounts.polygon.activate(
  'did:bloque:account:polygon:0x05B10c9B6241b73fc8c906fB7979eFc7764AB731'
);

freeze()

Freeze a Polygon account.
await bloque.accounts.polygon.freeze(
  urn: string
): Promise<PolygonAccount>

Parameters

urn
string
required
Polygon account URN

Returns

PolygonAccount
object
Updated polygon account

Example

const account = await bloque.accounts.polygon.freeze(
  'did:bloque:account:polygon:0x05B10c9B6241b73fc8c906fB7979eFc7764AB731'
);

disable()

Disable a Polygon account.
await bloque.accounts.polygon.disable(
  urn: string
): Promise<PolygonAccount>

Parameters

urn
string
required
Polygon account URN

Returns

PolygonAccount
object
Updated polygon account

Example

const account = await bloque.accounts.polygon.disable(
  'did:bloque:account:polygon:0x05B10c9B6241b73fc8c906fB7979eFc7764AB731'
);

Build docs developers (and LLMs) love